conductor-node-mcp 15.1.0 → 15.2.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/local-docs-search.js +37 -37
- package/local-docs-search.mjs +37 -37
- package/package.json +2 -2
- package/server.d.mts +1 -1
- package/server.d.ts +1 -1
- package/server.js +2 -2
- package/server.mjs +2 -2
- package/src/local-docs-search.ts +37 -37
- package/src/server.ts +2 -2
package/local-docs-search.js
CHANGED
|
@@ -458,7 +458,7 @@ const EMBEDDED_METHODS = [
|
|
|
458
458
|
'vendorIds?: string[];',
|
|
459
459
|
],
|
|
460
460
|
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; }; }",
|
|
461
|
-
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
|
|
461
|
+
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 20 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```",
|
|
462
462
|
perLanguage: {
|
|
463
463
|
typescript: {
|
|
464
464
|
method: 'client.qbd.billCheckPayments.list',
|
|
@@ -650,7 +650,7 @@ const EMBEDDED_METHODS = [
|
|
|
650
650
|
'vendorIds?: string[];',
|
|
651
651
|
],
|
|
652
652
|
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; }; }",
|
|
653
|
-
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
|
|
653
|
+
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 20 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```",
|
|
654
654
|
perLanguage: {
|
|
655
655
|
typescript: {
|
|
656
656
|
method: 'client.qbd.billCreditCardPayments.list',
|
|
@@ -813,7 +813,7 @@ const EMBEDDED_METHODS = [
|
|
|
813
813
|
'vendorIds?: string[];',
|
|
814
814
|
],
|
|
815
815
|
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; }",
|
|
816
|
-
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```",
|
|
816
|
+
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 20 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```",
|
|
817
817
|
perLanguage: {
|
|
818
818
|
typescript: {
|
|
819
819
|
method: 'client.qbd.bills.list',
|
|
@@ -1045,7 +1045,7 @@ const EMBEDDED_METHODS = [
|
|
|
1045
1045
|
'updatedBefore?: string;',
|
|
1046
1046
|
],
|
|
1047
1047
|
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; }",
|
|
1048
|
-
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
|
|
1048
|
+
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 20 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```",
|
|
1049
1049
|
perLanguage: {
|
|
1050
1050
|
typescript: {
|
|
1051
1051
|
method: 'client.qbd.buildAssemblies.list',
|
|
@@ -1221,7 +1221,7 @@ const EMBEDDED_METHODS = [
|
|
|
1221
1221
|
'updatedBefore?: string;',
|
|
1222
1222
|
],
|
|
1223
1223
|
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; }",
|
|
1224
|
-
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```",
|
|
1224
|
+
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 20 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```",
|
|
1225
1225
|
perLanguage: {
|
|
1226
1226
|
typescript: {
|
|
1227
1227
|
method: 'client.qbd.checks.list',
|
|
@@ -1567,7 +1567,7 @@ const EMBEDDED_METHODS = [
|
|
|
1567
1567
|
'updatedBefore?: string;',
|
|
1568
1568
|
],
|
|
1569
1569
|
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; }",
|
|
1570
|
-
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```",
|
|
1570
|
+
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 20 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```",
|
|
1571
1571
|
perLanguage: {
|
|
1572
1572
|
typescript: {
|
|
1573
1573
|
method: 'client.qbd.creditCardCharges.list',
|
|
@@ -1765,7 +1765,7 @@ const EMBEDDED_METHODS = [
|
|
|
1765
1765
|
'updatedBefore?: string;',
|
|
1766
1766
|
],
|
|
1767
1767
|
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; }",
|
|
1768
|
-
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```",
|
|
1768
|
+
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 20 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```",
|
|
1769
1769
|
perLanguage: {
|
|
1770
1770
|
typescript: {
|
|
1771
1771
|
method: 'client.qbd.creditCardCredits.list',
|
|
@@ -1964,7 +1964,7 @@ const EMBEDDED_METHODS = [
|
|
|
1964
1964
|
'updatedBefore?: string;',
|
|
1965
1965
|
],
|
|
1966
1966
|
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; }",
|
|
1967
|
-
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```",
|
|
1967
|
+
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 20 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```",
|
|
1968
1968
|
perLanguage: {
|
|
1969
1969
|
typescript: {
|
|
1970
1970
|
method: 'client.qbd.creditCardRefunds.list',
|
|
@@ -2138,7 +2138,7 @@ const EMBEDDED_METHODS = [
|
|
|
2138
2138
|
'updatedBefore?: string;',
|
|
2139
2139
|
],
|
|
2140
2140
|
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; }",
|
|
2141
|
-
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```",
|
|
2141
|
+
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 20 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```",
|
|
2142
2142
|
perLanguage: {
|
|
2143
2143
|
typescript: {
|
|
2144
2144
|
method: 'client.qbd.creditMemos.list',
|
|
@@ -2605,7 +2605,7 @@ const EMBEDDED_METHODS = [
|
|
|
2605
2605
|
'updatedBefore?: string;',
|
|
2606
2606
|
],
|
|
2607
2607
|
response: 'object',
|
|
2608
|
-
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```",
|
|
2608
|
+
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 20 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```",
|
|
2609
2609
|
perLanguage: {
|
|
2610
2610
|
typescript: {
|
|
2611
2611
|
method: 'client.qbd.customers.list',
|
|
@@ -2933,7 +2933,7 @@ const EMBEDDED_METHODS = [
|
|
|
2933
2933
|
'updatedBefore?: string;',
|
|
2934
2934
|
],
|
|
2935
2935
|
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; }",
|
|
2936
|
-
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
|
|
2936
|
+
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 20 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```",
|
|
2937
2937
|
perLanguage: {
|
|
2938
2938
|
typescript: {
|
|
2939
2939
|
method: 'client.qbd.deposits.list',
|
|
@@ -3122,7 +3122,7 @@ const EMBEDDED_METHODS = [
|
|
|
3122
3122
|
'updatedBefore?: string;',
|
|
3123
3123
|
],
|
|
3124
3124
|
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; }",
|
|
3125
|
-
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
|
|
3125
|
+
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 20 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```",
|
|
3126
3126
|
perLanguage: {
|
|
3127
3127
|
typescript: {
|
|
3128
3128
|
method: 'client.qbd.discountItems.list',
|
|
@@ -3490,7 +3490,7 @@ const EMBEDDED_METHODS = [
|
|
|
3490
3490
|
'updatedBefore?: string;',
|
|
3491
3491
|
],
|
|
3492
3492
|
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; }",
|
|
3493
|
-
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```",
|
|
3493
|
+
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 20 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```",
|
|
3494
3494
|
perLanguage: {
|
|
3495
3495
|
typescript: {
|
|
3496
3496
|
method: 'client.qbd.estimates.list',
|
|
@@ -3873,7 +3873,7 @@ const EMBEDDED_METHODS = [
|
|
|
3873
3873
|
'updatedBefore?: string;',
|
|
3874
3874
|
],
|
|
3875
3875
|
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; }",
|
|
3876
|
-
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
|
|
3876
|
+
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 20 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```",
|
|
3877
3877
|
perLanguage: {
|
|
3878
3878
|
typescript: {
|
|
3879
3879
|
method: 'client.qbd.inventoryAssemblyItems.list',
|
|
@@ -4040,7 +4040,7 @@ const EMBEDDED_METHODS = [
|
|
|
4040
4040
|
'updatedBefore?: string;',
|
|
4041
4041
|
],
|
|
4042
4042
|
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; }",
|
|
4043
|
-
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
|
|
4043
|
+
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 20 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```",
|
|
4044
4044
|
perLanguage: {
|
|
4045
4045
|
typescript: {
|
|
4046
4046
|
method: 'client.qbd.inventoryItems.list',
|
|
@@ -4352,7 +4352,7 @@ const EMBEDDED_METHODS = [
|
|
|
4352
4352
|
'updatedBefore?: string;',
|
|
4353
4353
|
],
|
|
4354
4354
|
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; }",
|
|
4355
|
-
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```",
|
|
4355
|
+
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 20 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```",
|
|
4356
4356
|
perLanguage: {
|
|
4357
4357
|
typescript: {
|
|
4358
4358
|
method: 'client.qbd.invoices.list',
|
|
@@ -4557,7 +4557,7 @@ const EMBEDDED_METHODS = [
|
|
|
4557
4557
|
'updatedBefore?: string;',
|
|
4558
4558
|
],
|
|
4559
4559
|
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; }",
|
|
4560
|
-
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
|
|
4560
|
+
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 20 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```",
|
|
4561
4561
|
perLanguage: {
|
|
4562
4562
|
typescript: {
|
|
4563
4563
|
method: 'client.qbd.itemGroups.list',
|
|
@@ -4704,7 +4704,7 @@ const EMBEDDED_METHODS = [
|
|
|
4704
4704
|
'vendorIds?: string[];',
|
|
4705
4705
|
],
|
|
4706
4706
|
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; }",
|
|
4707
|
-
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```",
|
|
4707
|
+
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 20 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```",
|
|
4708
4708
|
perLanguage: {
|
|
4709
4709
|
typescript: {
|
|
4710
4710
|
method: 'client.qbd.itemReceipts.list',
|
|
@@ -4854,7 +4854,7 @@ const EMBEDDED_METHODS = [
|
|
|
4854
4854
|
"status?: 'active' | 'all' | 'inactive';",
|
|
4855
4855
|
],
|
|
4856
4856
|
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; }",
|
|
4857
|
-
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
|
|
4857
|
+
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 20 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```",
|
|
4858
4858
|
perLanguage: {
|
|
4859
4859
|
typescript: {
|
|
4860
4860
|
method: 'client.qbd.itemSites.list',
|
|
@@ -4960,7 +4960,7 @@ const EMBEDDED_METHODS = [
|
|
|
4960
4960
|
'updatedBefore?: string;',
|
|
4961
4961
|
],
|
|
4962
4962
|
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; }",
|
|
4963
|
-
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
|
|
4963
|
+
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 20 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```",
|
|
4964
4964
|
perLanguage: {
|
|
4965
4965
|
typescript: {
|
|
4966
4966
|
method: 'client.qbd.journalEntries.list',
|
|
@@ -5149,7 +5149,7 @@ const EMBEDDED_METHODS = [
|
|
|
5149
5149
|
'updatedBefore?: string;',
|
|
5150
5150
|
],
|
|
5151
5151
|
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; }",
|
|
5152
|
-
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
|
|
5152
|
+
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 20 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```",
|
|
5153
5153
|
perLanguage: {
|
|
5154
5154
|
typescript: {
|
|
5155
5155
|
method: 'client.qbd.nonInventoryItems.list',
|
|
@@ -5290,7 +5290,7 @@ const EMBEDDED_METHODS = [
|
|
|
5290
5290
|
'updatedBefore?: string;',
|
|
5291
5291
|
],
|
|
5292
5292
|
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; }",
|
|
5293
|
-
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
|
|
5293
|
+
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 20 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```",
|
|
5294
5294
|
perLanguage: {
|
|
5295
5295
|
typescript: {
|
|
5296
5296
|
method: 'client.qbd.otherChargeItems.list',
|
|
@@ -5696,7 +5696,7 @@ const EMBEDDED_METHODS = [
|
|
|
5696
5696
|
'updatedBefore?: string;',
|
|
5697
5697
|
],
|
|
5698
5698
|
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; }",
|
|
5699
|
-
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
|
|
5699
|
+
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 20 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```",
|
|
5700
5700
|
perLanguage: {
|
|
5701
5701
|
typescript: {
|
|
5702
5702
|
method: 'client.qbd.payrollWageItems.list',
|
|
@@ -5974,7 +5974,7 @@ const EMBEDDED_METHODS = [
|
|
|
5974
5974
|
'vendorIds?: string[];',
|
|
5975
5975
|
],
|
|
5976
5976
|
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; }",
|
|
5977
|
-
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```",
|
|
5977
|
+
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 20 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```",
|
|
5978
5978
|
perLanguage: {
|
|
5979
5979
|
typescript: {
|
|
5980
5980
|
method: 'client.qbd.purchaseOrders.list',
|
|
@@ -6162,7 +6162,7 @@ const EMBEDDED_METHODS = [
|
|
|
6162
6162
|
'updatedBefore?: string;',
|
|
6163
6163
|
],
|
|
6164
6164
|
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; }",
|
|
6165
|
-
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```",
|
|
6165
|
+
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 20 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```",
|
|
6166
6166
|
perLanguage: {
|
|
6167
6167
|
typescript: {
|
|
6168
6168
|
method: 'client.qbd.receivePayments.list',
|
|
@@ -6852,7 +6852,7 @@ const EMBEDDED_METHODS = [
|
|
|
6852
6852
|
'updatedBefore?: string;',
|
|
6853
6853
|
],
|
|
6854
6854
|
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; }",
|
|
6855
|
-
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```",
|
|
6855
|
+
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 20 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```",
|
|
6856
6856
|
perLanguage: {
|
|
6857
6857
|
typescript: {
|
|
6858
6858
|
method: 'client.qbd.salesOrders.list',
|
|
@@ -7058,7 +7058,7 @@ const EMBEDDED_METHODS = [
|
|
|
7058
7058
|
'updatedBefore?: string;',
|
|
7059
7059
|
],
|
|
7060
7060
|
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; }",
|
|
7061
|
-
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```",
|
|
7061
|
+
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 20 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```",
|
|
7062
7062
|
perLanguage: {
|
|
7063
7063
|
typescript: {
|
|
7064
7064
|
method: 'client.qbd.salesReceipts.list',
|
|
@@ -7514,7 +7514,7 @@ const EMBEDDED_METHODS = [
|
|
|
7514
7514
|
'updatedBefore?: string;',
|
|
7515
7515
|
],
|
|
7516
7516
|
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; }",
|
|
7517
|
-
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
|
|
7517
|
+
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 20 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```",
|
|
7518
7518
|
perLanguage: {
|
|
7519
7519
|
typescript: {
|
|
7520
7520
|
method: 'client.qbd.salesTaxGroupItems.list',
|
|
@@ -7649,7 +7649,7 @@ const EMBEDDED_METHODS = [
|
|
|
7649
7649
|
'updatedBefore?: string;',
|
|
7650
7650
|
],
|
|
7651
7651
|
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; }",
|
|
7652
|
-
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
|
|
7652
|
+
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 20 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```",
|
|
7653
7653
|
perLanguage: {
|
|
7654
7654
|
typescript: {
|
|
7655
7655
|
method: 'client.qbd.salesTaxItems.list',
|
|
@@ -7791,7 +7791,7 @@ const EMBEDDED_METHODS = [
|
|
|
7791
7791
|
'vendorIds?: string[];',
|
|
7792
7792
|
],
|
|
7793
7793
|
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; }; }",
|
|
7794
|
-
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
|
|
7794
|
+
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 20 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```",
|
|
7795
7795
|
perLanguage: {
|
|
7796
7796
|
typescript: {
|
|
7797
7797
|
method: 'client.qbd.salesTaxPaymentChecks.list',
|
|
@@ -7978,7 +7978,7 @@ const EMBEDDED_METHODS = [
|
|
|
7978
7978
|
'updatedBefore?: string;',
|
|
7979
7979
|
],
|
|
7980
7980
|
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; }",
|
|
7981
|
-
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
|
|
7981
|
+
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 20 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```",
|
|
7982
7982
|
perLanguage: {
|
|
7983
7983
|
typescript: {
|
|
7984
7984
|
method: 'client.qbd.serviceItems.list',
|
|
@@ -8296,7 +8296,7 @@ const EMBEDDED_METHODS = [
|
|
|
8296
8296
|
'updatedBefore?: string;',
|
|
8297
8297
|
],
|
|
8298
8298
|
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; }",
|
|
8299
|
-
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
|
|
8299
|
+
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 20 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```",
|
|
8300
8300
|
perLanguage: {
|
|
8301
8301
|
typescript: {
|
|
8302
8302
|
method: 'client.qbd.subtotalItems.list',
|
|
@@ -8451,7 +8451,7 @@ const EMBEDDED_METHODS = [
|
|
|
8451
8451
|
'updatedBefore?: string;',
|
|
8452
8452
|
],
|
|
8453
8453
|
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; }",
|
|
8454
|
-
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
|
|
8454
|
+
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 20 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```",
|
|
8455
8455
|
perLanguage: {
|
|
8456
8456
|
typescript: {
|
|
8457
8457
|
method: 'client.qbd.timeTrackingActivities.list',
|
|
@@ -8588,7 +8588,7 @@ const EMBEDDED_METHODS = [
|
|
|
8588
8588
|
'updatedBefore?: string;',
|
|
8589
8589
|
],
|
|
8590
8590
|
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; }',
|
|
8591
|
-
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```",
|
|
8591
|
+
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 20 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```",
|
|
8592
8592
|
perLanguage: {
|
|
8593
8593
|
typescript: {
|
|
8594
8594
|
method: 'client.qbd.transactions.list',
|
|
@@ -8680,7 +8680,7 @@ const EMBEDDED_METHODS = [
|
|
|
8680
8680
|
'updatedBefore?: string;',
|
|
8681
8681
|
],
|
|
8682
8682
|
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; }",
|
|
8683
|
-
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
|
|
8683
|
+
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 20 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```",
|
|
8684
8684
|
perLanguage: {
|
|
8685
8685
|
typescript: {
|
|
8686
8686
|
method: 'client.qbd.transfers.list',
|
|
@@ -8919,7 +8919,7 @@ const EMBEDDED_METHODS = [
|
|
|
8919
8919
|
'vendorIds?: string[];',
|
|
8920
8920
|
],
|
|
8921
8921
|
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; }",
|
|
8922
|
-
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```",
|
|
8922
|
+
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 20 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```",
|
|
8923
8923
|
perLanguage: {
|
|
8924
8924
|
typescript: {
|
|
8925
8925
|
method: 'client.qbd.vendorCredits.list',
|
|
@@ -9154,7 +9154,7 @@ const EMBEDDED_METHODS = [
|
|
|
9154
9154
|
'updatedBefore?: string;',
|
|
9155
9155
|
],
|
|
9156
9156
|
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; }",
|
|
9157
|
-
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```",
|
|
9157
|
+
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 20 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```",
|
|
9158
9158
|
perLanguage: {
|
|
9159
9159
|
typescript: {
|
|
9160
9160
|
method: 'client.qbd.vendors.list',
|