conductor-node-mcp 14.18.0 → 14.20.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/code-tool-worker.d.mts.map +1 -1
- package/code-tool-worker.d.ts.map +1 -1
- package/code-tool-worker.js +10 -0
- package/code-tool-worker.js.map +1 -1
- package/code-tool-worker.mjs +10 -0
- package/code-tool-worker.mjs.map +1 -1
- package/local-docs-search.d.mts.map +1 -1
- package/local-docs-search.d.ts.map +1 -1
- package/local-docs-search.js +365 -44
- package/local-docs-search.js.map +1 -1
- package/local-docs-search.mjs +365 -44
- package/local-docs-search.mjs.map +1 -1
- package/methods.d.mts.map +1 -1
- package/methods.d.ts.map +1 -1
- package/methods.js +60 -0
- package/methods.js.map +1 -1
- package/methods.mjs +60 -0
- package/methods.mjs.map +1 -1
- package/package.json +2 -2
- package/server.js +1 -1
- package/server.mjs +1 -1
- package/src/code-tool-worker.ts +10 -0
- package/src/local-docs-search.ts +421 -44
- package/src/methods.ts +60 -0
- package/src/server.ts +1 -1
package/local-docs-search.js
CHANGED
|
@@ -177,12 +177,12 @@ const EMBEDDED_METHODS = [
|
|
|
177
177
|
endpoint: '/end-users/{id}/passthrough/{integrationSlug}',
|
|
178
178
|
httpMethod: 'post',
|
|
179
179
|
summary: 'Passthrough',
|
|
180
|
-
description:
|
|
180
|
+
description: "Rare escape hatch for sending raw QuickBooks Desktop qbXML request objects directly. Prefer Conductor's native QuickBooks Desktop endpoints whenever possible: Conductor already exposes more than 250 typed QBD endpoints, covers nearly the entire underlying qbXML API surface, returns all documented response fields in a stable typed JSON shape, and powers Conductor SDK types, documentation, IDE autocomplete, and the API Playground. Use passthrough only when you need one of the few qbXML operations that is not yet available as a native Conductor endpoint, or while testing an unsupported qbXML operation. Known gaps are listed in [Missing QBD types](/api-ref/missing-qbd-types).",
|
|
181
181
|
stainlessPath: '(resource) end_users > (method) passthrough',
|
|
182
182
|
qualified: 'client.endUsers.passthrough',
|
|
183
183
|
params: ['id: string;', "integrationSlug: 'quickbooks_desktop';", 'qbd_payload: object;'],
|
|
184
184
|
response: 'object',
|
|
185
|
-
markdown: "## passthrough\n\n`conductor.endUsers.passthrough(id: string, integrationSlug: 'quickbooks_desktop', qbd_payload: object): object`\n\n**post** `/end-users/{id}/passthrough/{integrationSlug}`\n\
|
|
185
|
+
markdown: "## passthrough\n\n`conductor.endUsers.passthrough(id: string, integrationSlug: 'quickbooks_desktop', qbd_payload: object): object`\n\n**post** `/end-users/{id}/passthrough/{integrationSlug}`\n\nRare escape hatch for sending raw QuickBooks Desktop qbXML request objects directly. Prefer Conductor's native QuickBooks Desktop endpoints whenever possible: Conductor already exposes more than 250 typed QBD endpoints, covers nearly the entire underlying qbXML API surface, returns all documented response fields in a stable typed JSON shape, and powers Conductor SDK types, documentation, IDE autocomplete, and the API Playground. Use passthrough only when you need one of the few qbXML operations that is not yet available as a native Conductor endpoint, or while testing an unsupported qbXML operation. Known gaps are listed in [Missing QBD types](/api-ref/missing-qbd-types).\n\n### Parameters\n\n- `id: string`\n The ID of the end-user who owns the integration connection.\n\n- `integrationSlug: 'quickbooks_desktop'`\n The integration identifier for the end-user's connection.\n\n- `qbd_payload: object`\n The raw qbXML request object to send to the integration connection. For QuickBooks Desktop, use a qbXML request wrapper such as `InvoiceQueryRq` or `CustomerQueryRq`. This body is forwarded directly and does not use Conductor field names.\n\n### Returns\n\n- `object`\n The raw response from the integration connection. For QuickBooks Desktop, this is the qbXML response converted to JSON.\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst response = await conductor.endUsers.passthrough('quickbooks_desktop', {\n id: 'end_usr_1234567abcdefg',\n qbd_payload: { foo: 'bar' },\n});\n\nconsole.log(response);\n```",
|
|
186
186
|
perLanguage: {
|
|
187
187
|
typescript: {
|
|
188
188
|
method: 'client.endUsers.passthrough',
|
|
@@ -565,12 +565,12 @@ const EMBEDDED_METHODS = [
|
|
|
565
565
|
endpoint: '/quickbooks-desktop/bill-check-payments/{id}',
|
|
566
566
|
httpMethod: 'delete',
|
|
567
567
|
summary: 'Delete a bill check payment',
|
|
568
|
-
description: 'Permanently deletes a
|
|
568
|
+
description: 'Permanently deletes a bill check payment. The deletion will fail if the bill check payment is currently in use or has any linked transactions that are in use.',
|
|
569
569
|
stainlessPath: '(resource) qbd.bill_check_payments > (method) delete',
|
|
570
570
|
qualified: 'client.qbd.billCheckPayments.delete',
|
|
571
571
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
572
572
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_bill_check_payment'; refNumber: string; }",
|
|
573
|
-
markdown: "## delete\n\n`conductor.qbd.billCheckPayments.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_bill_check_payment'; refNumber: string; }`\n\n**delete** `/quickbooks-desktop/bill-check-payments/{id}`\n\nPermanently deletes a
|
|
573
|
+
markdown: "## delete\n\n`conductor.qbd.billCheckPayments.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_bill_check_payment'; refNumber: string; }`\n\n**delete** `/quickbooks-desktop/bill-check-payments/{id}`\n\nPermanently deletes a bill check payment. The deletion will fail if the bill check payment is currently in use or has any linked transactions that are in use.\n\n### Parameters\n\n- `id: string`\n The QuickBooks-assigned unique identifier of the bill check payment to delete.\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n### Returns\n\n- `{ id: string; deleted: boolean; objectType: 'qbd_bill_check_payment'; refNumber: string; }`\n\n - `id: string`\n - `deleted: boolean`\n - `objectType: 'qbd_bill_check_payment'`\n - `refNumber: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst billCheckPayment = await conductor.qbd.billCheckPayments.delete('123ABC-1234567890', { conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(billCheckPayment);\n```",
|
|
574
574
|
perLanguage: {
|
|
575
575
|
typescript: {
|
|
576
576
|
method: 'client.qbd.billCheckPayments.delete',
|
|
@@ -720,12 +720,12 @@ const EMBEDDED_METHODS = [
|
|
|
720
720
|
endpoint: '/quickbooks-desktop/bill-credit-card-payments/{id}',
|
|
721
721
|
httpMethod: 'delete',
|
|
722
722
|
summary: 'Delete a bill credit card payment',
|
|
723
|
-
description: 'Permanently deletes a
|
|
723
|
+
description: 'Permanently deletes a bill credit card payment. The deletion will fail if the bill credit card payment is currently in use or has any linked transactions that are in use.',
|
|
724
724
|
stainlessPath: '(resource) qbd.bill_credit_card_payments > (method) delete',
|
|
725
725
|
qualified: 'client.qbd.billCreditCardPayments.delete',
|
|
726
726
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
727
727
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_bill_credit_card_payment'; refNumber: string; }",
|
|
728
|
-
markdown: "## delete\n\n`conductor.qbd.billCreditCardPayments.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_bill_credit_card_payment'; refNumber: string; }`\n\n**delete** `/quickbooks-desktop/bill-credit-card-payments/{id}`\n\nPermanently deletes a
|
|
728
|
+
markdown: "## delete\n\n`conductor.qbd.billCreditCardPayments.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_bill_credit_card_payment'; refNumber: string; }`\n\n**delete** `/quickbooks-desktop/bill-credit-card-payments/{id}`\n\nPermanently deletes a bill credit card payment. The deletion will fail if the bill credit card payment is currently in use or has any linked transactions that are in use.\n\n### Parameters\n\n- `id: string`\n The QuickBooks-assigned unique identifier of the bill credit card payment to delete.\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n### Returns\n\n- `{ id: string; deleted: boolean; objectType: 'qbd_bill_credit_card_payment'; refNumber: string; }`\n\n - `id: string`\n - `deleted: boolean`\n - `objectType: 'qbd_bill_credit_card_payment'`\n - `refNumber: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst billCreditCardPayment = await conductor.qbd.billCreditCardPayments.delete('123ABC-1234567890', { conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(billCreditCardPayment);\n```",
|
|
729
729
|
perLanguage: {
|
|
730
730
|
typescript: {
|
|
731
731
|
method: 'client.qbd.billCreditCardPayments.delete',
|
|
@@ -927,12 +927,12 @@ const EMBEDDED_METHODS = [
|
|
|
927
927
|
endpoint: '/quickbooks-desktop/bills/{id}',
|
|
928
928
|
httpMethod: 'delete',
|
|
929
929
|
summary: 'Delete a bill',
|
|
930
|
-
description: 'Permanently deletes a
|
|
930
|
+
description: 'Permanently deletes a bill. The deletion will fail if the bill is currently in use or has any linked transactions that are in use.',
|
|
931
931
|
stainlessPath: '(resource) qbd.bills > (method) delete',
|
|
932
932
|
qualified: 'client.qbd.bills.delete',
|
|
933
933
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
934
934
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_bill'; refNumber: string; }",
|
|
935
|
-
markdown: "## delete\n\n`conductor.qbd.bills.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_bill'; refNumber: string; }`\n\n**delete** `/quickbooks-desktop/bills/{id}`\n\nPermanently deletes a
|
|
935
|
+
markdown: "## delete\n\n`conductor.qbd.bills.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_bill'; refNumber: string; }`\n\n**delete** `/quickbooks-desktop/bills/{id}`\n\nPermanently deletes a bill. The deletion will fail if the bill is currently in use or has any linked transactions that are in use.\n\n### Parameters\n\n- `id: string`\n The QuickBooks-assigned unique identifier of the bill to delete.\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n### Returns\n\n- `{ id: string; deleted: boolean; objectType: 'qbd_bill'; refNumber: string; }`\n\n - `id: string`\n - `deleted: boolean`\n - `objectType: 'qbd_bill'`\n - `refNumber: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst bill = await conductor.qbd.bills.delete('123ABC-1234567890', { conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(bill);\n```",
|
|
936
936
|
perLanguage: {
|
|
937
937
|
typescript: {
|
|
938
938
|
method: 'client.qbd.bills.delete',
|
|
@@ -1130,12 +1130,12 @@ const EMBEDDED_METHODS = [
|
|
|
1130
1130
|
endpoint: '/quickbooks-desktop/build-assemblies/{id}',
|
|
1131
1131
|
httpMethod: 'delete',
|
|
1132
1132
|
summary: 'Delete a build assembly',
|
|
1133
|
-
description: 'Permanently deletes a
|
|
1133
|
+
description: 'Permanently deletes a build assembly. The deletion will fail if the build assembly is currently in use or has any linked transactions that are in use.',
|
|
1134
1134
|
stainlessPath: '(resource) qbd.build_assemblies > (method) delete',
|
|
1135
1135
|
qualified: 'client.qbd.buildAssemblies.delete',
|
|
1136
1136
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
1137
1137
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_build_assembly'; refNumber: string; }",
|
|
1138
|
-
markdown: "## delete\n\n`conductor.qbd.buildAssemblies.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_build_assembly'; refNumber: string; }`\n\n**delete** `/quickbooks-desktop/build-assemblies/{id}`\n\nPermanently deletes a
|
|
1138
|
+
markdown: "## delete\n\n`conductor.qbd.buildAssemblies.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_build_assembly'; refNumber: string; }`\n\n**delete** `/quickbooks-desktop/build-assemblies/{id}`\n\nPermanently deletes a build assembly. The deletion will fail if the build assembly is currently in use or has any linked transactions that are in use.\n\n### Parameters\n\n- `id: string`\n The QuickBooks-assigned unique identifier of the build assembly to delete.\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n### Returns\n\n- `{ id: string; deleted: boolean; objectType: 'qbd_build_assembly'; refNumber: string; }`\n\n - `id: string`\n - `deleted: boolean`\n - `objectType: 'qbd_build_assembly'`\n - `refNumber: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst buildAssembly = await conductor.qbd.buildAssemblies.delete('123ABC-1234567890', { conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(buildAssembly);\n```",
|
|
1139
1139
|
perLanguage: {
|
|
1140
1140
|
typescript: {
|
|
1141
1141
|
method: 'client.qbd.buildAssemblies.delete',
|
|
@@ -1335,12 +1335,12 @@ const EMBEDDED_METHODS = [
|
|
|
1335
1335
|
endpoint: '/quickbooks-desktop/checks/{id}',
|
|
1336
1336
|
httpMethod: 'delete',
|
|
1337
1337
|
summary: 'Delete a check',
|
|
1338
|
-
description: 'Permanently deletes a
|
|
1338
|
+
description: 'Permanently deletes a check. The deletion will fail if the check is currently in use or has any linked transactions that are in use.',
|
|
1339
1339
|
stainlessPath: '(resource) qbd.checks > (method) delete',
|
|
1340
1340
|
qualified: 'client.qbd.checks.delete',
|
|
1341
1341
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
1342
1342
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_check'; refNumber: string; }",
|
|
1343
|
-
markdown: "## delete\n\n`conductor.qbd.checks.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_check'; refNumber: string; }`\n\n**delete** `/quickbooks-desktop/checks/{id}`\n\nPermanently deletes a
|
|
1343
|
+
markdown: "## delete\n\n`conductor.qbd.checks.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_check'; refNumber: string; }`\n\n**delete** `/quickbooks-desktop/checks/{id}`\n\nPermanently deletes a check. The deletion will fail if the check is currently in use or has any linked transactions that are in use.\n\n### Parameters\n\n- `id: string`\n The QuickBooks-assigned unique identifier of the check to delete.\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n### Returns\n\n- `{ id: string; deleted: boolean; objectType: 'qbd_check'; refNumber: string; }`\n\n - `id: string`\n - `deleted: boolean`\n - `objectType: 'qbd_check'`\n - `refNumber: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst check = await conductor.qbd.checks.delete('123ABC-1234567890', { conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(check);\n```",
|
|
1344
1344
|
perLanguage: {
|
|
1345
1345
|
typescript: {
|
|
1346
1346
|
method: 'client.qbd.checks.delete',
|
|
@@ -1678,12 +1678,12 @@ const EMBEDDED_METHODS = [
|
|
|
1678
1678
|
endpoint: '/quickbooks-desktop/credit-card-charges/{id}',
|
|
1679
1679
|
httpMethod: 'delete',
|
|
1680
1680
|
summary: 'Delete a credit card charge',
|
|
1681
|
-
description: 'Permanently deletes a
|
|
1681
|
+
description: 'Permanently deletes a credit card charge. The deletion will fail if the credit card charge is currently in use or has any linked transactions that are in use.',
|
|
1682
1682
|
stainlessPath: '(resource) qbd.credit_card_charges > (method) delete',
|
|
1683
1683
|
qualified: 'client.qbd.creditCardCharges.delete',
|
|
1684
1684
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
1685
1685
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_credit_card_charge'; refNumber: string; }",
|
|
1686
|
-
markdown: "## delete\n\n`conductor.qbd.creditCardCharges.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_credit_card_charge'; refNumber: string; }`\n\n**delete** `/quickbooks-desktop/credit-card-charges/{id}`\n\nPermanently deletes a
|
|
1686
|
+
markdown: "## delete\n\n`conductor.qbd.creditCardCharges.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_credit_card_charge'; refNumber: string; }`\n\n**delete** `/quickbooks-desktop/credit-card-charges/{id}`\n\nPermanently deletes a credit card charge. The deletion will fail if the credit card charge is currently in use or has any linked transactions that are in use.\n\n### Parameters\n\n- `id: string`\n The QuickBooks-assigned unique identifier of the credit card charge to delete.\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n### Returns\n\n- `{ id: string; deleted: boolean; objectType: 'qbd_credit_card_charge'; refNumber: string; }`\n\n - `id: string`\n - `deleted: boolean`\n - `objectType: 'qbd_credit_card_charge'`\n - `refNumber: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst creditCardCharge = await conductor.qbd.creditCardCharges.delete('123ABC-1234567890', { conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(creditCardCharge);\n```",
|
|
1687
1687
|
perLanguage: {
|
|
1688
1688
|
typescript: {
|
|
1689
1689
|
method: 'client.qbd.creditCardCharges.delete',
|
|
@@ -1876,12 +1876,12 @@ const EMBEDDED_METHODS = [
|
|
|
1876
1876
|
endpoint: '/quickbooks-desktop/credit-card-credits/{id}',
|
|
1877
1877
|
httpMethod: 'delete',
|
|
1878
1878
|
summary: 'Delete a credit card credit',
|
|
1879
|
-
description: 'Permanently deletes a
|
|
1879
|
+
description: 'Permanently deletes a credit card credit. The deletion will fail if the credit card credit is currently in use or has any linked transactions that are in use.',
|
|
1880
1880
|
stainlessPath: '(resource) qbd.credit_card_credits > (method) delete',
|
|
1881
1881
|
qualified: 'client.qbd.creditCardCredits.delete',
|
|
1882
1882
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
1883
1883
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_credit_card_credit'; refNumber: string; }",
|
|
1884
|
-
markdown: "## delete\n\n`conductor.qbd.creditCardCredits.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_credit_card_credit'; refNumber: string; }`\n\n**delete** `/quickbooks-desktop/credit-card-credits/{id}`\n\nPermanently deletes a
|
|
1884
|
+
markdown: "## delete\n\n`conductor.qbd.creditCardCredits.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_credit_card_credit'; refNumber: string; }`\n\n**delete** `/quickbooks-desktop/credit-card-credits/{id}`\n\nPermanently deletes a credit card credit. The deletion will fail if the credit card credit is currently in use or has any linked transactions that are in use.\n\n### Parameters\n\n- `id: string`\n The QuickBooks-assigned unique identifier of the credit card credit to delete.\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n### Returns\n\n- `{ id: string; deleted: boolean; objectType: 'qbd_credit_card_credit'; refNumber: string; }`\n\n - `id: string`\n - `deleted: boolean`\n - `objectType: 'qbd_credit_card_credit'`\n - `refNumber: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst creditCardCredit = await conductor.qbd.creditCardCredits.delete('123ABC-1234567890', { conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(creditCardCredit);\n```",
|
|
1885
1885
|
perLanguage: {
|
|
1886
1886
|
typescript: {
|
|
1887
1887
|
method: 'client.qbd.creditCardCredits.delete',
|
|
@@ -2034,12 +2034,12 @@ const EMBEDDED_METHODS = [
|
|
|
2034
2034
|
endpoint: '/quickbooks-desktop/credit-card-refunds/{id}',
|
|
2035
2035
|
httpMethod: 'delete',
|
|
2036
2036
|
summary: 'Delete a credit card refund',
|
|
2037
|
-
description: 'Permanently deletes a
|
|
2037
|
+
description: 'Permanently deletes a credit card refund. The deletion will fail if the credit card refund is currently in use or has any linked transactions that are in use.',
|
|
2038
2038
|
stainlessPath: '(resource) qbd.credit_card_refunds > (method) delete',
|
|
2039
2039
|
qualified: 'client.qbd.creditCardRefunds.delete',
|
|
2040
2040
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
2041
2041
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_credit_card_refund'; refNumber: string; }",
|
|
2042
|
-
markdown: "## delete\n\n`conductor.qbd.creditCardRefunds.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_credit_card_refund'; refNumber: string; }`\n\n**delete** `/quickbooks-desktop/credit-card-refunds/{id}`\n\nPermanently deletes a
|
|
2042
|
+
markdown: "## delete\n\n`conductor.qbd.creditCardRefunds.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_credit_card_refund'; refNumber: string; }`\n\n**delete** `/quickbooks-desktop/credit-card-refunds/{id}`\n\nPermanently deletes a credit card refund. The deletion will fail if the credit card refund is currently in use or has any linked transactions that are in use.\n\n### Parameters\n\n- `id: string`\n The QuickBooks-assigned unique identifier of the credit card refund to delete.\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n### Returns\n\n- `{ id: string; deleted: boolean; objectType: 'qbd_credit_card_refund'; refNumber: string; }`\n\n - `id: string`\n - `deleted: boolean`\n - `objectType: 'qbd_credit_card_refund'`\n - `refNumber: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst creditCardRefund = await conductor.qbd.creditCardRefunds.delete('123ABC-1234567890', { conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(creditCardRefund);\n```",
|
|
2043
2043
|
perLanguage: {
|
|
2044
2044
|
typescript: {
|
|
2045
2045
|
method: 'client.qbd.creditCardRefunds.delete',
|
|
@@ -2263,12 +2263,12 @@ const EMBEDDED_METHODS = [
|
|
|
2263
2263
|
endpoint: '/quickbooks-desktop/credit-memos/{id}',
|
|
2264
2264
|
httpMethod: 'delete',
|
|
2265
2265
|
summary: 'Delete a credit memo',
|
|
2266
|
-
description: 'Permanently deletes a
|
|
2266
|
+
description: 'Permanently deletes a credit memo. The deletion will fail if the credit memo is currently in use or has any linked transactions that are in use.',
|
|
2267
2267
|
stainlessPath: '(resource) qbd.credit_memos > (method) delete',
|
|
2268
2268
|
qualified: 'client.qbd.creditMemos.delete',
|
|
2269
2269
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
2270
2270
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_credit_memo'; refNumber: string; }",
|
|
2271
|
-
markdown: "## delete\n\n`conductor.qbd.creditMemos.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_credit_memo'; refNumber: string; }`\n\n**delete** `/quickbooks-desktop/credit-memos/{id}`\n\nPermanently deletes a
|
|
2271
|
+
markdown: "## delete\n\n`conductor.qbd.creditMemos.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_credit_memo'; refNumber: string; }`\n\n**delete** `/quickbooks-desktop/credit-memos/{id}`\n\nPermanently deletes a credit memo. The deletion will fail if the credit memo is currently in use or has any linked transactions that are in use.\n\n### Parameters\n\n- `id: string`\n The QuickBooks-assigned unique identifier of the credit memo to delete.\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n### Returns\n\n- `{ id: string; deleted: boolean; objectType: 'qbd_credit_memo'; refNumber: string; }`\n\n - `id: string`\n - `deleted: boolean`\n - `objectType: 'qbd_credit_memo'`\n - `refNumber: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst creditMemo = await conductor.qbd.creditMemos.delete('123ABC-1234567890', { conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(creditMemo);\n```",
|
|
2272
2272
|
perLanguage: {
|
|
2273
2273
|
typescript: {
|
|
2274
2274
|
method: 'client.qbd.creditMemos.delete',
|
|
@@ -3039,12 +3039,12 @@ const EMBEDDED_METHODS = [
|
|
|
3039
3039
|
endpoint: '/quickbooks-desktop/deposits/{id}',
|
|
3040
3040
|
httpMethod: 'delete',
|
|
3041
3041
|
summary: 'Delete a deposit',
|
|
3042
|
-
description: 'Permanently deletes a
|
|
3042
|
+
description: 'Permanently deletes a deposit. The deletion will fail if the deposit is currently in use or has any linked transactions that are in use.',
|
|
3043
3043
|
stainlessPath: '(resource) qbd.deposits > (method) delete',
|
|
3044
3044
|
qualified: 'client.qbd.deposits.delete',
|
|
3045
3045
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
3046
3046
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_deposit'; }",
|
|
3047
|
-
markdown: "## delete\n\n`conductor.qbd.deposits.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_deposit'; }`\n\n**delete** `/quickbooks-desktop/deposits/{id}`\n\nPermanently deletes a
|
|
3047
|
+
markdown: "## delete\n\n`conductor.qbd.deposits.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_deposit'; }`\n\n**delete** `/quickbooks-desktop/deposits/{id}`\n\nPermanently deletes a deposit. The deletion will fail if the deposit is currently in use or has any linked transactions that are in use.\n\n### Parameters\n\n- `id: string`\n The QuickBooks-assigned unique identifier of the deposit to delete.\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n### Returns\n\n- `{ id: string; deleted: boolean; objectType: 'qbd_deposit'; }`\n\n - `id: string`\n - `deleted: boolean`\n - `objectType: 'qbd_deposit'`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst deposit = await conductor.qbd.deposits.delete('123ABC-1234567890', { conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(deposit);\n```",
|
|
3048
3048
|
perLanguage: {
|
|
3049
3049
|
typescript: {
|
|
3050
3050
|
method: 'client.qbd.deposits.delete',
|
|
@@ -3587,12 +3587,12 @@ const EMBEDDED_METHODS = [
|
|
|
3587
3587
|
endpoint: '/quickbooks-desktop/estimates/{id}',
|
|
3588
3588
|
httpMethod: 'delete',
|
|
3589
3589
|
summary: 'Delete an estimate',
|
|
3590
|
-
description: 'Permanently deletes
|
|
3590
|
+
description: 'Permanently deletes an estimate. The deletion will fail if the estimate is currently in use or has any linked transactions that are in use.',
|
|
3591
3591
|
stainlessPath: '(resource) qbd.estimates > (method) delete',
|
|
3592
3592
|
qualified: 'client.qbd.estimates.delete',
|
|
3593
3593
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
3594
3594
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_estimate'; refNumber: string; }",
|
|
3595
|
-
markdown: "## delete\n\n`conductor.qbd.estimates.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_estimate'; refNumber: string; }`\n\n**delete** `/quickbooks-desktop/estimates/{id}`\n\nPermanently deletes
|
|
3595
|
+
markdown: "## delete\n\n`conductor.qbd.estimates.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_estimate'; refNumber: string; }`\n\n**delete** `/quickbooks-desktop/estimates/{id}`\n\nPermanently deletes an estimate. The deletion will fail if the estimate is currently in use or has any linked transactions that are in use.\n\n### Parameters\n\n- `id: string`\n The QuickBooks-assigned unique identifier of the estimate to delete.\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n### Returns\n\n- `{ id: string; deleted: boolean; objectType: 'qbd_estimate'; refNumber: string; }`\n\n - `id: string`\n - `deleted: boolean`\n - `objectType: 'qbd_estimate'`\n - `refNumber: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst estimate = await conductor.qbd.estimates.delete('123ABC-1234567890', { conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(estimate);\n```",
|
|
3596
3596
|
perLanguage: {
|
|
3597
3597
|
typescript: {
|
|
3598
3598
|
method: 'client.qbd.estimates.delete',
|
|
@@ -3778,12 +3778,12 @@ const EMBEDDED_METHODS = [
|
|
|
3778
3778
|
endpoint: '/quickbooks-desktop/inventory-adjustments/{id}',
|
|
3779
3779
|
httpMethod: 'delete',
|
|
3780
3780
|
summary: 'Delete an inventory adjustment',
|
|
3781
|
-
description: 'Permanently deletes
|
|
3781
|
+
description: 'Permanently deletes an inventory adjustment. The deletion will fail if the inventory adjustment is currently in use or has any linked transactions that are in use.',
|
|
3782
3782
|
stainlessPath: '(resource) qbd.inventory_adjustments > (method) delete',
|
|
3783
3783
|
qualified: 'client.qbd.inventoryAdjustments.delete',
|
|
3784
3784
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
3785
3785
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_inventory_adjustment'; refNumber: string; }",
|
|
3786
|
-
markdown: "## delete\n\n`conductor.qbd.inventoryAdjustments.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_inventory_adjustment'; refNumber: string; }`\n\n**delete** `/quickbooks-desktop/inventory-adjustments/{id}`\n\nPermanently deletes
|
|
3786
|
+
markdown: "## delete\n\n`conductor.qbd.inventoryAdjustments.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_inventory_adjustment'; refNumber: string; }`\n\n**delete** `/quickbooks-desktop/inventory-adjustments/{id}`\n\nPermanently deletes an inventory adjustment. The deletion will fail if the inventory adjustment is currently in use or has any linked transactions that are in use.\n\n### Parameters\n\n- `id: string`\n The QuickBooks-assigned unique identifier of the inventory adjustment to delete.\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n### Returns\n\n- `{ id: string; deleted: boolean; objectType: 'qbd_inventory_adjustment'; refNumber: string; }`\n\n - `id: string`\n - `deleted: boolean`\n - `objectType: 'qbd_inventory_adjustment'`\n - `refNumber: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst inventoryAdjustment = await conductor.qbd.inventoryAdjustments.delete('123ABC-1234567890', { conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(inventoryAdjustment);\n```",
|
|
3787
3787
|
perLanguage: {
|
|
3788
3788
|
typescript: {
|
|
3789
3789
|
method: 'client.qbd.inventoryAdjustments.delete',
|
|
@@ -4478,12 +4478,12 @@ const EMBEDDED_METHODS = [
|
|
|
4478
4478
|
endpoint: '/quickbooks-desktop/invoices/{id}',
|
|
4479
4479
|
httpMethod: 'delete',
|
|
4480
4480
|
summary: 'Delete an invoice',
|
|
4481
|
-
description: 'Permanently deletes
|
|
4481
|
+
description: 'Permanently deletes an invoice. The deletion will fail if the invoice is currently in use or has any linked transactions that are in use.',
|
|
4482
4482
|
stainlessPath: '(resource) qbd.invoices > (method) delete',
|
|
4483
4483
|
qualified: 'client.qbd.invoices.delete',
|
|
4484
4484
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
4485
4485
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_invoice'; refNumber: string; }",
|
|
4486
|
-
markdown: "## delete\n\n`conductor.qbd.invoices.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_invoice'; refNumber: string; }`\n\n**delete** `/quickbooks-desktop/invoices/{id}`\n\nPermanently deletes
|
|
4486
|
+
markdown: "## delete\n\n`conductor.qbd.invoices.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_invoice'; refNumber: string; }`\n\n**delete** `/quickbooks-desktop/invoices/{id}`\n\nPermanently deletes an invoice. The deletion will fail if the invoice is currently in use or has any linked transactions that are in use.\n\n### Parameters\n\n- `id: string`\n The QuickBooks-assigned unique identifier of the invoice to delete.\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n### Returns\n\n- `{ id: string; deleted: boolean; objectType: 'qbd_invoice'; refNumber: string; }`\n\n - `id: string`\n - `deleted: boolean`\n - `objectType: 'qbd_invoice'`\n - `refNumber: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst invoice = await conductor.qbd.invoices.delete('123ABC-1234567890', { conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(invoice);\n```",
|
|
4487
4487
|
perLanguage: {
|
|
4488
4488
|
typescript: {
|
|
4489
4489
|
method: 'client.qbd.invoices.delete',
|
|
@@ -4815,12 +4815,12 @@ const EMBEDDED_METHODS = [
|
|
|
4815
4815
|
endpoint: '/quickbooks-desktop/item-receipts/{id}',
|
|
4816
4816
|
httpMethod: 'delete',
|
|
4817
4817
|
summary: 'Delete an item receipt',
|
|
4818
|
-
description: 'Permanently deletes
|
|
4818
|
+
description: 'Permanently deletes an item receipt. The deletion will fail if the item receipt is currently in use or has any linked transactions that are in use.',
|
|
4819
4819
|
stainlessPath: '(resource) qbd.item_receipts > (method) delete',
|
|
4820
4820
|
qualified: 'client.qbd.itemReceipts.delete',
|
|
4821
4821
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
4822
4822
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_item_receipt'; refNumber: string; }",
|
|
4823
|
-
markdown: "## delete\n\n`conductor.qbd.itemReceipts.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_item_receipt'; refNumber: string; }`\n\n**delete** `/quickbooks-desktop/item-receipts/{id}`\n\nPermanently deletes
|
|
4823
|
+
markdown: "## delete\n\n`conductor.qbd.itemReceipts.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_item_receipt'; refNumber: string; }`\n\n**delete** `/quickbooks-desktop/item-receipts/{id}`\n\nPermanently deletes an item receipt. The deletion will fail if the item receipt is currently in use or has any linked transactions that are in use.\n\n### Parameters\n\n- `id: string`\n The QuickBooks-assigned unique identifier of the item receipt to delete.\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n### Returns\n\n- `{ id: string; deleted: boolean; objectType: 'qbd_item_receipt'; refNumber: string; }`\n\n - `id: string`\n - `deleted: boolean`\n - `objectType: 'qbd_item_receipt'`\n - `refNumber: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst itemReceipt = await conductor.qbd.itemReceipts.delete('123ABC-1234567890', { conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(itemReceipt);\n```",
|
|
4824
4824
|
perLanguage: {
|
|
4825
4825
|
typescript: {
|
|
4826
4826
|
method: 'client.qbd.itemReceipts.delete',
|
|
@@ -5066,12 +5066,12 @@ const EMBEDDED_METHODS = [
|
|
|
5066
5066
|
endpoint: '/quickbooks-desktop/journal-entries/{id}',
|
|
5067
5067
|
httpMethod: 'delete',
|
|
5068
5068
|
summary: 'Delete a journal entry',
|
|
5069
|
-
description: 'Permanently deletes a
|
|
5069
|
+
description: 'Permanently deletes a journal entry. The deletion will fail if the journal entry is currently in use or has any linked transactions that are in use.',
|
|
5070
5070
|
stainlessPath: '(resource) qbd.journal_entries > (method) delete',
|
|
5071
5071
|
qualified: 'client.qbd.journalEntries.delete',
|
|
5072
5072
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
5073
5073
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_journal_entry'; refNumber: string; }",
|
|
5074
|
-
markdown: "## delete\n\n`conductor.qbd.journalEntries.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_journal_entry'; refNumber: string; }`\n\n**delete** `/quickbooks-desktop/journal-entries/{id}`\n\nPermanently deletes a
|
|
5074
|
+
markdown: "## delete\n\n`conductor.qbd.journalEntries.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_journal_entry'; refNumber: string; }`\n\n**delete** `/quickbooks-desktop/journal-entries/{id}`\n\nPermanently deletes a journal entry. The deletion will fail if the journal entry is currently in use or has any linked transactions that are in use.\n\n### Parameters\n\n- `id: string`\n The QuickBooks-assigned unique identifier of the journal entry to delete.\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n### Returns\n\n- `{ id: string; deleted: boolean; objectType: 'qbd_journal_entry'; refNumber: string; }`\n\n - `id: string`\n - `deleted: boolean`\n - `objectType: 'qbd_journal_entry'`\n - `refNumber: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst journalEntry = await conductor.qbd.journalEntries.delete('123ABC-1234567890', { conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(journalEntry);\n```",
|
|
5075
5075
|
perLanguage: {
|
|
5076
5076
|
typescript: {
|
|
5077
5077
|
method: 'client.qbd.journalEntries.delete',
|
|
@@ -6073,12 +6073,12 @@ const EMBEDDED_METHODS = [
|
|
|
6073
6073
|
endpoint: '/quickbooks-desktop/purchase-orders/{id}',
|
|
6074
6074
|
httpMethod: 'delete',
|
|
6075
6075
|
summary: 'Delete a purchase order',
|
|
6076
|
-
description: 'Permanently deletes a
|
|
6076
|
+
description: 'Permanently deletes a purchase order. The deletion will fail if the purchase order is currently in use or has any linked transactions that are in use.',
|
|
6077
6077
|
stainlessPath: '(resource) qbd.purchase_orders > (method) delete',
|
|
6078
6078
|
qualified: 'client.qbd.purchaseOrders.delete',
|
|
6079
6079
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
6080
6080
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_purchase_order'; refNumber: string; }",
|
|
6081
|
-
markdown: "## delete\n\n`conductor.qbd.purchaseOrders.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_purchase_order'; refNumber: string; }`\n\n**delete** `/quickbooks-desktop/purchase-orders/{id}`\n\nPermanently deletes a
|
|
6081
|
+
markdown: "## delete\n\n`conductor.qbd.purchaseOrders.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_purchase_order'; refNumber: string; }`\n\n**delete** `/quickbooks-desktop/purchase-orders/{id}`\n\nPermanently deletes a purchase order. The deletion will fail if the purchase order is currently in use or has any linked transactions that are in use.\n\n### Parameters\n\n- `id: string`\n The QuickBooks-assigned unique identifier of the purchase order to delete.\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n### Returns\n\n- `{ id: string; deleted: boolean; objectType: 'qbd_purchase_order'; refNumber: string; }`\n\n - `id: string`\n - `deleted: boolean`\n - `objectType: 'qbd_purchase_order'`\n - `refNumber: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst purchaseOrder = await conductor.qbd.purchaseOrders.delete('123ABC-1234567890', { conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(purchaseOrder);\n```",
|
|
6082
6082
|
perLanguage: {
|
|
6083
6083
|
typescript: {
|
|
6084
6084
|
method: 'client.qbd.purchaseOrders.delete',
|
|
@@ -6247,12 +6247,12 @@ const EMBEDDED_METHODS = [
|
|
|
6247
6247
|
endpoint: '/quickbooks-desktop/receive-payments/{id}',
|
|
6248
6248
|
httpMethod: 'delete',
|
|
6249
6249
|
summary: 'Delete a receive-payment',
|
|
6250
|
-
description: 'Permanently deletes a
|
|
6250
|
+
description: 'Permanently deletes a receive-payment. The deletion will fail if the receive-payment is currently in use or has any linked transactions that are in use.',
|
|
6251
6251
|
stainlessPath: '(resource) qbd.receive_payments > (method) delete',
|
|
6252
6252
|
qualified: 'client.qbd.receivePayments.delete',
|
|
6253
6253
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
6254
6254
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_receive_payment'; refNumber: string; }",
|
|
6255
|
-
markdown: "## delete\n\n`conductor.qbd.receivePayments.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_receive_payment'; refNumber: string; }`\n\n**delete** `/quickbooks-desktop/receive-payments/{id}`\n\nPermanently deletes a
|
|
6255
|
+
markdown: "## delete\n\n`conductor.qbd.receivePayments.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_receive_payment'; refNumber: string; }`\n\n**delete** `/quickbooks-desktop/receive-payments/{id}`\n\nPermanently deletes a receive-payment. The deletion will fail if the receive-payment is currently in use or has any linked transactions that are in use.\n\n### Parameters\n\n- `id: string`\n The QuickBooks-assigned unique identifier of the receive-payment to delete.\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n### Returns\n\n- `{ id: string; deleted: boolean; objectType: 'qbd_receive_payment'; refNumber: string; }`\n\n - `id: string`\n - `deleted: boolean`\n - `objectType: 'qbd_receive_payment'`\n - `refNumber: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst receivePayment = await conductor.qbd.receivePayments.delete('123ABC-1234567890', { conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(receivePayment);\n```",
|
|
6256
6256
|
perLanguage: {
|
|
6257
6257
|
typescript: {
|
|
6258
6258
|
method: 'client.qbd.receivePayments.delete',
|
|
@@ -6954,12 +6954,12 @@ const EMBEDDED_METHODS = [
|
|
|
6954
6954
|
endpoint: '/quickbooks-desktop/sales-orders/{id}',
|
|
6955
6955
|
httpMethod: 'delete',
|
|
6956
6956
|
summary: 'Delete a sales order',
|
|
6957
|
-
description: 'Permanently deletes a
|
|
6957
|
+
description: 'Permanently deletes a sales order. The deletion will fail if the sales order is currently in use or has any linked transactions that are in use.',
|
|
6958
6958
|
stainlessPath: '(resource) qbd.sales_orders > (method) delete',
|
|
6959
6959
|
qualified: 'client.qbd.salesOrders.delete',
|
|
6960
6960
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
6961
6961
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_sales_order'; refNumber: string; }",
|
|
6962
|
-
markdown: "## delete\n\n`conductor.qbd.salesOrders.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_sales_order'; refNumber: string; }`\n\n**delete** `/quickbooks-desktop/sales-orders/{id}`\n\nPermanently deletes a
|
|
6962
|
+
markdown: "## delete\n\n`conductor.qbd.salesOrders.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_sales_order'; refNumber: string; }`\n\n**delete** `/quickbooks-desktop/sales-orders/{id}`\n\nPermanently deletes a sales order. The deletion will fail if the sales order is currently in use or has any linked transactions that are in use.\n\n### Parameters\n\n- `id: string`\n The QuickBooks-assigned unique identifier of the sales order to delete.\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n### Returns\n\n- `{ id: string; deleted: boolean; objectType: 'qbd_sales_order'; refNumber: string; }`\n\n - `id: string`\n - `deleted: boolean`\n - `objectType: 'qbd_sales_order'`\n - `refNumber: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst salesOrder = await conductor.qbd.salesOrders.delete('123ABC-1234567890', { conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(salesOrder);\n```",
|
|
6963
6963
|
perLanguage: {
|
|
6964
6964
|
typescript: {
|
|
6965
6965
|
method: 'client.qbd.salesOrders.delete',
|
|
@@ -7183,12 +7183,12 @@ const EMBEDDED_METHODS = [
|
|
|
7183
7183
|
endpoint: '/quickbooks-desktop/sales-receipts/{id}',
|
|
7184
7184
|
httpMethod: 'delete',
|
|
7185
7185
|
summary: 'Delete a sales receipt',
|
|
7186
|
-
description: 'Permanently deletes a
|
|
7186
|
+
description: 'Permanently deletes a sales receipt. The deletion will fail if the sales receipt is currently in use or has any linked transactions that are in use.',
|
|
7187
7187
|
stainlessPath: '(resource) qbd.sales_receipts > (method) delete',
|
|
7188
7188
|
qualified: 'client.qbd.salesReceipts.delete',
|
|
7189
7189
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
7190
7190
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_sales_receipt'; refNumber: string; }",
|
|
7191
|
-
markdown: "## delete\n\n`conductor.qbd.salesReceipts.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_sales_receipt'; refNumber: string; }`\n\n**delete** `/quickbooks-desktop/sales-receipts/{id}`\n\nPermanently deletes a
|
|
7191
|
+
markdown: "## delete\n\n`conductor.qbd.salesReceipts.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_sales_receipt'; refNumber: string; }`\n\n**delete** `/quickbooks-desktop/sales-receipts/{id}`\n\nPermanently deletes a sales receipt. The deletion will fail if the sales receipt is currently in use or has any linked transactions that are in use.\n\n### Parameters\n\n- `id: string`\n The QuickBooks-assigned unique identifier of the sales receipt to delete.\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n### Returns\n\n- `{ id: string; deleted: boolean; objectType: 'qbd_sales_receipt'; refNumber: string; }`\n\n - `id: string`\n - `deleted: boolean`\n - `objectType: 'qbd_sales_receipt'`\n - `refNumber: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst salesReceipt = await conductor.qbd.salesReceipts.delete('123ABC-1234567890', { conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(salesReceipt);\n```",
|
|
7192
7192
|
perLanguage: {
|
|
7193
7193
|
typescript: {
|
|
7194
7194
|
method: 'client.qbd.salesReceipts.delete',
|
|
@@ -7457,6 +7457,137 @@ const EMBEDDED_METHODS = [
|
|
|
7457
7457
|
},
|
|
7458
7458
|
},
|
|
7459
7459
|
},
|
|
7460
|
+
{
|
|
7461
|
+
name: 'create',
|
|
7462
|
+
endpoint: '/quickbooks-desktop/sales-tax-group-items',
|
|
7463
|
+
httpMethod: 'post',
|
|
7464
|
+
summary: 'Create a sales-tax group item',
|
|
7465
|
+
description: 'Creates a new sales-tax group item.',
|
|
7466
|
+
stainlessPath: '(resource) qbd.sales_tax_group_items > (method) create',
|
|
7467
|
+
qualified: 'client.qbd.salesTaxGroupItems.create',
|
|
7468
|
+
params: [
|
|
7469
|
+
'name: string;',
|
|
7470
|
+
'salesTaxItemIds: string[];',
|
|
7471
|
+
'Conductor-End-User-Id: string;',
|
|
7472
|
+
'barcode?: { allowOverride?: boolean; assignEvenIfUsed?: boolean; value?: string; };',
|
|
7473
|
+
'description?: string;',
|
|
7474
|
+
'externalId?: string;',
|
|
7475
|
+
'isActive?: boolean;',
|
|
7476
|
+
],
|
|
7477
|
+
response: "{ id: string; barcode: string; createdAt: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; description: string; externalId: string; isActive: boolean; name: string; objectType: 'qbd_sales_tax_group_item'; revisionNumber: string; salesTaxItems: { id: string; fullName: string; }[]; updatedAt: string; }",
|
|
7478
|
+
markdown: "## create\n\n`conductor.qbd.salesTaxGroupItems.create(name: string, salesTaxItemIds: string[], Conductor-End-User-Id: string, barcode?: { allowOverride?: boolean; assignEvenIfUsed?: boolean; value?: string; }, description?: string, externalId?: string, isActive?: boolean): { 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**post** `/quickbooks-desktop/sales-tax-group-items`\n\nCreates a new sales-tax group item.\n\n### Parameters\n\n- `name: string`\n The case-insensitive unique name of this sales-tax group item, unique across all sales-tax group items.\n\n**NOTE**: Sales-tax group items do not have a `fullName` field because they are not hierarchical objects, which is why `name` is unique for them but not for objects that have parents.\n\nMaximum length: 31 characters.\n\n- `salesTaxItemIds: string[]`\n The sales-tax items that make up this sales-tax group item. QuickBooks Desktop applies these sales-tax items together as one tax selection while tracking each sales tax separately.\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `barcode?: { allowOverride?: boolean; assignEvenIfUsed?: boolean; value?: string; }`\n The sales-tax group item's barcode.\n - `allowOverride?: boolean`\n Indicates whether to allow the barcode to be overridden.\n - `assignEvenIfUsed?: boolean`\n Indicates whether to assign the barcode even if it is already used.\n - `value?: string`\n The item's barcode value.\n\n- `description?: string`\n The sales-tax group item's description that will appear on sales forms that include this item.\n\n- `externalId?: string`\n A globally unique identifier (GUID) you, the developer, can provide for tracking this object in your external system. This field is immutable and can only be set during object creation.\n\n**IMPORTANT**: This field must be formatted as a valid GUID; otherwise, QuickBooks will return an error.\n\n- `isActive?: boolean`\n Indicates whether this sales-tax group item is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to `true`.\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\nconst salesTaxGroupItem = await conductor.qbd.salesTaxGroupItems.create({\n name: 'Standard Tax Group',\n salesTaxItemIds: ['80000001-1234567890'],\n conductorEndUserId: 'end_usr_1234567abcdefg',\n});\n\nconsole.log(salesTaxGroupItem);\n```",
|
|
7479
|
+
perLanguage: {
|
|
7480
|
+
typescript: {
|
|
7481
|
+
method: 'client.qbd.salesTaxGroupItems.create',
|
|
7482
|
+
example: "import Conductor from 'conductor-node';\n\nconst conductor = new Conductor({\n apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted\n});\n\nconst salesTaxGroupItem = await conductor.qbd.salesTaxGroupItems.create({\n name: 'Standard Tax Group',\n salesTaxItemIds: ['80000001-1234567890'],\n conductorEndUserId: 'end_usr_1234567abcdefg',\n});\n\nconsole.log(salesTaxGroupItem.id);",
|
|
7483
|
+
},
|
|
7484
|
+
python: {
|
|
7485
|
+
method: 'qbd.sales_tax_group_items.create',
|
|
7486
|
+
example: 'import os\nfrom conductor import Conductor\n\nconductor = Conductor(\n api_key=os.environ.get("CONDUCTOR_SECRET_KEY"), # This is the default and can be omitted\n)\nsales_tax_group_item = conductor.qbd.sales_tax_group_items.create(\n name="Standard Tax Group",\n sales_tax_item_ids=["80000001-1234567890"],\n conductor_end_user_id="end_usr_1234567abcdefg",\n)\nprint(sales_tax_group_item.id)',
|
|
7487
|
+
},
|
|
7488
|
+
http: {
|
|
7489
|
+
example: 'curl https://api.conductor.is/v1/quickbooks-desktop/sales-tax-group-items \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $CONDUCTOR_SECRET_KEY" \\\n -d \'{\n "name": "Standard Tax Group",\n "salesTaxItemIds": [\n "80000001-1234567890"\n ],\n "description": "Combined city, county, and state sales tax",\n "externalId": "12345678-abcd-1234-abcd-1234567890ab",\n "isActive": true\n }\'',
|
|
7490
|
+
},
|
|
7491
|
+
},
|
|
7492
|
+
},
|
|
7493
|
+
{
|
|
7494
|
+
name: 'list',
|
|
7495
|
+
endpoint: '/quickbooks-desktop/sales-tax-group-items',
|
|
7496
|
+
httpMethod: 'get',
|
|
7497
|
+
summary: 'List all sales-tax group items',
|
|
7498
|
+
description: 'Returns a list of sales-tax group items. Use the `cursor` parameter to paginate through the results.',
|
|
7499
|
+
stainlessPath: '(resource) qbd.sales_tax_group_items > (method) list',
|
|
7500
|
+
qualified: 'client.qbd.salesTaxGroupItems.list',
|
|
7501
|
+
params: [
|
|
7502
|
+
'Conductor-End-User-Id: string;',
|
|
7503
|
+
'cursor?: string;',
|
|
7504
|
+
'ids?: string[];',
|
|
7505
|
+
'limit?: number;',
|
|
7506
|
+
'nameContains?: string;',
|
|
7507
|
+
'nameEndsWith?: string;',
|
|
7508
|
+
'nameFrom?: string;',
|
|
7509
|
+
'names?: string[];',
|
|
7510
|
+
'nameStartsWith?: string;',
|
|
7511
|
+
'nameTo?: string;',
|
|
7512
|
+
"status?: 'active' | 'all' | 'inactive';",
|
|
7513
|
+
'updatedAfter?: string;',
|
|
7514
|
+
'updatedBefore?: string;',
|
|
7515
|
+
],
|
|
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- `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` is alphabetically greater than or equal to this value.\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` is alphabetically less than or equal to this value.\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
|
+
perLanguage: {
|
|
7519
|
+
typescript: {
|
|
7520
|
+
method: 'client.qbd.salesTaxGroupItems.list',
|
|
7521
|
+
example: "import Conductor from 'conductor-node';\n\nconst conductor = new Conductor({\n apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const salesTaxGroupItem of conductor.qbd.salesTaxGroupItems.list({\n conductorEndUserId: 'end_usr_1234567abcdefg',\n})) {\n console.log(salesTaxGroupItem.id);\n}",
|
|
7522
|
+
},
|
|
7523
|
+
python: {
|
|
7524
|
+
method: 'qbd.sales_tax_group_items.list',
|
|
7525
|
+
example: 'import os\nfrom conductor import Conductor\n\nconductor = Conductor(\n api_key=os.environ.get("CONDUCTOR_SECRET_KEY"), # This is the default and can be omitted\n)\npage = conductor.qbd.sales_tax_group_items.list(\n conductor_end_user_id="end_usr_1234567abcdefg",\n)\npage = page.data[0]\nprint(page.id)',
|
|
7526
|
+
},
|
|
7527
|
+
http: {
|
|
7528
|
+
example: 'curl https://api.conductor.is/v1/quickbooks-desktop/sales-tax-group-items \\\n -H "Authorization: Bearer $CONDUCTOR_SECRET_KEY"',
|
|
7529
|
+
},
|
|
7530
|
+
},
|
|
7531
|
+
},
|
|
7532
|
+
{
|
|
7533
|
+
name: 'retrieve',
|
|
7534
|
+
endpoint: '/quickbooks-desktop/sales-tax-group-items/{id}',
|
|
7535
|
+
httpMethod: 'get',
|
|
7536
|
+
summary: 'Retrieve a sales-tax group item',
|
|
7537
|
+
description: 'Retrieves a sales-tax group item by ID.\n\n**IMPORTANT:** If you need to fetch multiple specific sales-tax group items by ID, use the list endpoint instead with the `ids` parameter. It accepts an array of IDs so you can batch the request into a single call, which is significantly faster.',
|
|
7538
|
+
stainlessPath: '(resource) qbd.sales_tax_group_items > (method) retrieve',
|
|
7539
|
+
qualified: 'client.qbd.salesTaxGroupItems.retrieve',
|
|
7540
|
+
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
7541
|
+
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; }",
|
|
7542
|
+
markdown: "## retrieve\n\n`conductor.qbd.salesTaxGroupItems.retrieve(id: string, Conductor-End-User-Id: 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/{id}`\n\nRetrieves a sales-tax group item by ID.\n\n**IMPORTANT:** If you need to fetch multiple specific sales-tax group items by ID, use the list endpoint instead with the `ids` parameter. It accepts an array of IDs so you can batch the request into a single call, which is significantly faster.\n\n### Parameters\n\n- `id: string`\n The QuickBooks-assigned unique identifier of the sales-tax group item to retrieve.\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\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\nconst salesTaxGroupItem = await conductor.qbd.salesTaxGroupItems.retrieve('80000001-1234567890', { conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(salesTaxGroupItem);\n```",
|
|
7543
|
+
perLanguage: {
|
|
7544
|
+
typescript: {
|
|
7545
|
+
method: 'client.qbd.salesTaxGroupItems.retrieve',
|
|
7546
|
+
example: "import Conductor from 'conductor-node';\n\nconst conductor = new Conductor({\n apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted\n});\n\nconst salesTaxGroupItem = await conductor.qbd.salesTaxGroupItems.retrieve('80000001-1234567890', {\n conductorEndUserId: 'end_usr_1234567abcdefg',\n});\n\nconsole.log(salesTaxGroupItem.id);",
|
|
7547
|
+
},
|
|
7548
|
+
python: {
|
|
7549
|
+
method: 'qbd.sales_tax_group_items.retrieve',
|
|
7550
|
+
example: 'import os\nfrom conductor import Conductor\n\nconductor = Conductor(\n api_key=os.environ.get("CONDUCTOR_SECRET_KEY"), # This is the default and can be omitted\n)\nsales_tax_group_item = conductor.qbd.sales_tax_group_items.retrieve(\n id="80000001-1234567890",\n conductor_end_user_id="end_usr_1234567abcdefg",\n)\nprint(sales_tax_group_item.id)',
|
|
7551
|
+
},
|
|
7552
|
+
http: {
|
|
7553
|
+
example: 'curl https://api.conductor.is/v1/quickbooks-desktop/sales-tax-group-items/$ID \\\n -H "Authorization: Bearer $CONDUCTOR_SECRET_KEY"',
|
|
7554
|
+
},
|
|
7555
|
+
},
|
|
7556
|
+
},
|
|
7557
|
+
{
|
|
7558
|
+
name: 'update',
|
|
7559
|
+
endpoint: '/quickbooks-desktop/sales-tax-group-items/{id}',
|
|
7560
|
+
httpMethod: 'post',
|
|
7561
|
+
summary: 'Update a sales-tax group item',
|
|
7562
|
+
description: 'Updates an existing sales-tax group item.',
|
|
7563
|
+
stainlessPath: '(resource) qbd.sales_tax_group_items > (method) update',
|
|
7564
|
+
qualified: 'client.qbd.salesTaxGroupItems.update',
|
|
7565
|
+
params: [
|
|
7566
|
+
'id: string;',
|
|
7567
|
+
'revisionNumber: string;',
|
|
7568
|
+
'Conductor-End-User-Id: string;',
|
|
7569
|
+
'barcode?: { allowOverride?: boolean; assignEvenIfUsed?: boolean; value?: string; };',
|
|
7570
|
+
'description?: string;',
|
|
7571
|
+
'isActive?: boolean;',
|
|
7572
|
+
'name?: string;',
|
|
7573
|
+
'salesTaxItemIds?: string[];',
|
|
7574
|
+
],
|
|
7575
|
+
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; }",
|
|
7576
|
+
markdown: "## update\n\n`conductor.qbd.salesTaxGroupItems.update(id: string, revisionNumber: string, Conductor-End-User-Id: string, barcode?: { allowOverride?: boolean; assignEvenIfUsed?: boolean; value?: string; }, description?: string, isActive?: boolean, name?: string, salesTaxItemIds?: 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**post** `/quickbooks-desktop/sales-tax-group-items/{id}`\n\nUpdates an existing sales-tax group item.\n\n### Parameters\n\n- `id: string`\n The QuickBooks-assigned unique identifier of the sales-tax group item to update.\n\n- `revisionNumber: string`\n The current QuickBooks-assigned revision number of the sales-tax group item object you are updating, which you can get by fetching the object first. Provide the most recent `revisionNumber` to ensure you're working with the latest data; otherwise, the update will return an error.\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `barcode?: { allowOverride?: boolean; assignEvenIfUsed?: boolean; value?: string; }`\n The sales-tax group item's barcode.\n - `allowOverride?: boolean`\n Indicates whether to allow the barcode to be overridden.\n - `assignEvenIfUsed?: boolean`\n Indicates whether to assign the barcode even if it is already used.\n - `value?: string`\n The item's barcode value.\n\n- `description?: string`\n The sales-tax group item's description that will appear on sales forms that include this item.\n\n- `isActive?: boolean`\n Indicates whether this sales-tax group item is active. Inactive objects are typically hidden from views and reports in QuickBooks. Defaults to `true`.\n\n- `name?: string`\n The case-insensitive unique name of this sales-tax group item, unique across all sales-tax group items.\n\n**NOTE**: Sales-tax group items do not have a `fullName` field because they are not hierarchical objects, which is why `name` is unique for them but not for objects that have parents.\n\nMaximum length: 31 characters.\n\n- `salesTaxItemIds?: string[]`\n The sales-tax items that make up this sales-tax group item. QuickBooks Desktop applies these sales-tax items together as one tax selection while tracking each sales tax separately.\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\nconst salesTaxGroupItem = await conductor.qbd.salesTaxGroupItems.update('80000001-1234567890', { revisionNumber: '1721172183', conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(salesTaxGroupItem);\n```",
|
|
7577
|
+
perLanguage: {
|
|
7578
|
+
typescript: {
|
|
7579
|
+
method: 'client.qbd.salesTaxGroupItems.update',
|
|
7580
|
+
example: "import Conductor from 'conductor-node';\n\nconst conductor = new Conductor({\n apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted\n});\n\nconst salesTaxGroupItem = await conductor.qbd.salesTaxGroupItems.update('80000001-1234567890', {\n revisionNumber: '1721172183',\n conductorEndUserId: 'end_usr_1234567abcdefg',\n});\n\nconsole.log(salesTaxGroupItem.id);",
|
|
7581
|
+
},
|
|
7582
|
+
python: {
|
|
7583
|
+
method: 'qbd.sales_tax_group_items.update',
|
|
7584
|
+
example: 'import os\nfrom conductor import Conductor\n\nconductor = Conductor(\n api_key=os.environ.get("CONDUCTOR_SECRET_KEY"), # This is the default and can be omitted\n)\nsales_tax_group_item = conductor.qbd.sales_tax_group_items.update(\n id="80000001-1234567890",\n revision_number="1721172183",\n conductor_end_user_id="end_usr_1234567abcdefg",\n)\nprint(sales_tax_group_item.id)',
|
|
7585
|
+
},
|
|
7586
|
+
http: {
|
|
7587
|
+
example: 'curl https://api.conductor.is/v1/quickbooks-desktop/sales-tax-group-items/$ID \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $CONDUCTOR_SECRET_KEY" \\\n -d \'{\n "revisionNumber": "1721172183",\n "description": "Combined city, county, and state sales tax",\n "isActive": true,\n "name": "Standard Tax Group",\n "salesTaxItemIds": [\n "80000001-1234567890"\n ]\n }\'',
|
|
7588
|
+
},
|
|
7589
|
+
},
|
|
7590
|
+
},
|
|
7460
7591
|
{
|
|
7461
7592
|
name: 'create',
|
|
7462
7593
|
endpoint: '/quickbooks-desktop/sales-tax-items',
|
|
@@ -7595,6 +7726,196 @@ const EMBEDDED_METHODS = [
|
|
|
7595
7726
|
},
|
|
7596
7727
|
},
|
|
7597
7728
|
},
|
|
7729
|
+
{
|
|
7730
|
+
name: 'create',
|
|
7731
|
+
endpoint: '/quickbooks-desktop/sales-tax-payment-checks',
|
|
7732
|
+
httpMethod: 'post',
|
|
7733
|
+
summary: 'Create a sales-tax payment check',
|
|
7734
|
+
description: 'Creates a new sales-tax payment check.',
|
|
7735
|
+
stainlessPath: '(resource) qbd.sales_tax_payment_checks > (method) create',
|
|
7736
|
+
qualified: 'client.qbd.salesTaxPaymentChecks.create',
|
|
7737
|
+
params: [
|
|
7738
|
+
'bankAccountId: string;',
|
|
7739
|
+
'lines: { amount: string; salesTaxItemId?: string; }[];',
|
|
7740
|
+
'transactionDate: string;',
|
|
7741
|
+
'vendorId: string;',
|
|
7742
|
+
'Conductor-End-User-Id: string;',
|
|
7743
|
+
'address?: { city?: string; country?: string; line1?: string; line2?: string; line3?: string; line4?: string; line5?: string; note?: string; postalCode?: string; state?: string; };',
|
|
7744
|
+
'externalId?: string;',
|
|
7745
|
+
'isQueuedForPrint?: boolean;',
|
|
7746
|
+
'memo?: string;',
|
|
7747
|
+
'refNumber?: string;',
|
|
7748
|
+
],
|
|
7749
|
+
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; }; }",
|
|
7750
|
+
markdown: "## create\n\n`conductor.qbd.salesTaxPaymentChecks.create(bankAccountId: string, lines: { amount: string; salesTaxItemId?: string; }[], transactionDate: string, vendorId: string, Conductor-End-User-Id: string, address?: { city?: string; country?: string; line1?: string; line2?: string; line3?: string; line4?: string; line5?: string; note?: string; postalCode?: string; state?: string; }, externalId?: string, isQueuedForPrint?: boolean, memo?: string, refNumber?: 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**post** `/quickbooks-desktop/sales-tax-payment-checks`\n\nCreates a new sales-tax payment check.\n\n### Parameters\n\n- `bankAccountId: string`\n The bank account from which the funds are being drawn for this sales-tax payment check; e.g., Checking or Savings. This sales-tax payment check will decrease the balance of this account.\n\n- `lines: { amount: string; salesTaxItemId?: string; }[]`\n The payment lines in this sales-tax payment check, each recording an amount paid toward a sales-tax item.\n\n- `transactionDate: string`\n The date of this sales-tax payment check, in ISO 8601 format (YYYY-MM-DD).\n\n- `vendorId: string`\n The sales-tax agency, represented as a QuickBooks vendor, receiving this sales-tax payment check. This must match the tax vendor associated with the sales-tax items in the payment lines.\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `address?: { city?: string; country?: string; line1?: string; line2?: string; line3?: string; line4?: string; line5?: string; note?: string; postalCode?: string; state?: string; }`\n The address that is printed on the sales-tax payment check.\n - `city?: string`\n The city, district, suburb, town, or village name of the address.\n\nMaximum length: 31 characters.\n - `country?: string`\n The country name of the address.\n - `line1?: string`\n The first line of the address (e.g., street, PO Box, or company name).\n\nMaximum length: 41 characters.\n - `line2?: string`\n The second line of the address, if needed (e.g., apartment, suite, unit, or building).\n\nMaximum length: 41 characters.\n - `line3?: string`\n The third line of the address, if needed.\n\nMaximum length: 41 characters.\n - `line4?: string`\n The fourth line of the address, if needed.\n\nMaximum length: 41 characters.\n - `line5?: string`\n The fifth line of the address, if needed.\n\nMaximum length: 41 characters.\n - `note?: string`\n A note written at the bottom of the address in the form in which it appears, such as the invoice form.\n - `postalCode?: string`\n The postal code or ZIP code of the address.\n\nMaximum length: 13 characters.\n - `state?: string`\n The state, county, province, or region name of the address.\n\nMaximum length: 21 characters.\n\n- `externalId?: string`\n A globally unique identifier (GUID) you, the developer, can provide for tracking this object in your external system. This field is immutable and can only be set during object creation.\n\n**IMPORTANT**: This field must be formatted as a valid GUID; otherwise, QuickBooks will return an error.\n\n- `isQueuedForPrint?: boolean`\n Indicates whether this sales-tax payment check is included in the queue of documents for QuickBooks to print.\n\n- `memo?: string`\n A memo or note for this sales-tax payment check.\n\n- `refNumber?: string`\n The case-sensitive user-defined reference number for this sales-tax payment check, which can be used to identify the transaction in QuickBooks. This value is not required to be unique and can be arbitrarily changed by the QuickBooks user. When left blank in this create request, this field will be left blank in QuickBooks (i.e., it does *not* auto-increment).\n\n**IMPORTANT**: For checks, this field is the check number.\n\nMaximum length: 11 characters.\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\nconst salesTaxPaymentCheck = await conductor.qbd.salesTaxPaymentChecks.create({\n bankAccountId: '80000001-1234567890',\n lines: [{ amount: '1000.00' }],\n transactionDate: '2024-10-01',\n vendorId: '80000001-1234567890',\n conductorEndUserId: 'end_usr_1234567abcdefg',\n});\n\nconsole.log(salesTaxPaymentCheck);\n```",
|
|
7751
|
+
perLanguage: {
|
|
7752
|
+
typescript: {
|
|
7753
|
+
method: 'client.qbd.salesTaxPaymentChecks.create',
|
|
7754
|
+
example: "import Conductor from 'conductor-node';\n\nconst conductor = new Conductor({\n apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted\n});\n\nconst salesTaxPaymentCheck = await conductor.qbd.salesTaxPaymentChecks.create({\n bankAccountId: '80000001-1234567890',\n lines: [{ amount: '1000.00' }],\n transactionDate: '2024-10-01',\n vendorId: '80000001-1234567890',\n conductorEndUserId: 'end_usr_1234567abcdefg',\n});\n\nconsole.log(salesTaxPaymentCheck.id);",
|
|
7755
|
+
},
|
|
7756
|
+
python: {
|
|
7757
|
+
method: 'qbd.sales_tax_payment_checks.create',
|
|
7758
|
+
example: 'import os\nfrom datetime import date\nfrom conductor import Conductor\n\nconductor = Conductor(\n api_key=os.environ.get("CONDUCTOR_SECRET_KEY"), # This is the default and can be omitted\n)\nsales_tax_payment_check = conductor.qbd.sales_tax_payment_checks.create(\n bank_account_id="80000001-1234567890",\n lines=[{\n "amount": "1000.00"\n }],\n transaction_date=date.fromisoformat("2024-10-01"),\n vendor_id="80000001-1234567890",\n conductor_end_user_id="end_usr_1234567abcdefg",\n)\nprint(sales_tax_payment_check.id)',
|
|
7759
|
+
},
|
|
7760
|
+
http: {
|
|
7761
|
+
example: 'curl https://api.conductor.is/v1/quickbooks-desktop/sales-tax-payment-checks \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $CONDUCTOR_SECRET_KEY" \\\n -d \'{\n "bankAccountId": "80000001-1234567890",\n "lines": [\n {\n "amount": "1000.00"\n }\n ],\n "transactionDate": "2024-10-01",\n "vendorId": "80000001-1234567890",\n "externalId": "12345678-abcd-1234-abcd-1234567890ab",\n "isQueuedForPrint": true,\n "memo": "Sales tax payment for Q3 2024",\n "refNumber": "TAXPMT-1234"\n }\'',
|
|
7762
|
+
},
|
|
7763
|
+
},
|
|
7764
|
+
},
|
|
7765
|
+
{
|
|
7766
|
+
name: 'list',
|
|
7767
|
+
endpoint: '/quickbooks-desktop/sales-tax-payment-checks',
|
|
7768
|
+
httpMethod: 'get',
|
|
7769
|
+
summary: 'List all sales-tax payment checks',
|
|
7770
|
+
description: 'Returns a list of sales-tax payment checks. Use the `cursor` parameter to paginate through the results.',
|
|
7771
|
+
stainlessPath: '(resource) qbd.sales_tax_payment_checks > (method) list',
|
|
7772
|
+
qualified: 'client.qbd.salesTaxPaymentChecks.list',
|
|
7773
|
+
params: [
|
|
7774
|
+
'Conductor-End-User-Id: string;',
|
|
7775
|
+
'accountIds?: string[];',
|
|
7776
|
+
'cursor?: string;',
|
|
7777
|
+
'ids?: string[];',
|
|
7778
|
+
'includeLineItems?: boolean;',
|
|
7779
|
+
'itemIds?: string[];',
|
|
7780
|
+
'limit?: number;',
|
|
7781
|
+
'refNumberContains?: string;',
|
|
7782
|
+
'refNumberEndsWith?: string;',
|
|
7783
|
+
'refNumberFrom?: string;',
|
|
7784
|
+
'refNumbers?: string[];',
|
|
7785
|
+
'refNumberStartsWith?: string;',
|
|
7786
|
+
'refNumberTo?: string;',
|
|
7787
|
+
'transactionDateFrom?: string;',
|
|
7788
|
+
'transactionDateTo?: string;',
|
|
7789
|
+
'updatedAfter?: string;',
|
|
7790
|
+
'updatedBefore?: string;',
|
|
7791
|
+
'vendorIds?: string[];',
|
|
7792
|
+
],
|
|
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- `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- `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- `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
|
+
perLanguage: {
|
|
7796
|
+
typescript: {
|
|
7797
|
+
method: 'client.qbd.salesTaxPaymentChecks.list',
|
|
7798
|
+
example: "import Conductor from 'conductor-node';\n\nconst conductor = new Conductor({\n apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted\n});\n\n// Automatically fetches more pages as needed.\nfor await (const salesTaxPaymentCheck of conductor.qbd.salesTaxPaymentChecks.list({\n conductorEndUserId: 'end_usr_1234567abcdefg',\n})) {\n console.log(salesTaxPaymentCheck.id);\n}",
|
|
7799
|
+
},
|
|
7800
|
+
python: {
|
|
7801
|
+
method: 'qbd.sales_tax_payment_checks.list',
|
|
7802
|
+
example: 'import os\nfrom conductor import Conductor\n\nconductor = Conductor(\n api_key=os.environ.get("CONDUCTOR_SECRET_KEY"), # This is the default and can be omitted\n)\npage = conductor.qbd.sales_tax_payment_checks.list(\n conductor_end_user_id="end_usr_1234567abcdefg",\n)\npage = page.data[0]\nprint(page.id)',
|
|
7803
|
+
},
|
|
7804
|
+
http: {
|
|
7805
|
+
example: 'curl https://api.conductor.is/v1/quickbooks-desktop/sales-tax-payment-checks \\\n -H "Authorization: Bearer $CONDUCTOR_SECRET_KEY"',
|
|
7806
|
+
},
|
|
7807
|
+
},
|
|
7808
|
+
},
|
|
7809
|
+
{
|
|
7810
|
+
name: 'retrieve',
|
|
7811
|
+
endpoint: '/quickbooks-desktop/sales-tax-payment-checks/{id}',
|
|
7812
|
+
httpMethod: 'get',
|
|
7813
|
+
summary: 'Retrieve a sales-tax payment check',
|
|
7814
|
+
description: 'Retrieves a sales-tax payment check by ID.\n\n**IMPORTANT:** If you need to fetch multiple specific sales-tax payment checks by ID, use the list endpoint instead with the `ids` parameter. It accepts an array of IDs so you can batch the request into a single call, which is significantly faster.',
|
|
7815
|
+
stainlessPath: '(resource) qbd.sales_tax_payment_checks > (method) retrieve',
|
|
7816
|
+
qualified: 'client.qbd.salesTaxPaymentChecks.retrieve',
|
|
7817
|
+
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
7818
|
+
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; }; }",
|
|
7819
|
+
markdown: "## retrieve\n\n`conductor.qbd.salesTaxPaymentChecks.retrieve(id: string, Conductor-End-User-Id: 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/{id}`\n\nRetrieves a sales-tax payment check by ID.\n\n**IMPORTANT:** If you need to fetch multiple specific sales-tax payment checks by ID, use the list endpoint instead with the `ids` parameter. It accepts an array of IDs so you can batch the request into a single call, which is significantly faster.\n\n### Parameters\n\n- `id: string`\n The QuickBooks-assigned unique identifier of the sales-tax payment check to retrieve.\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\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\nconst salesTaxPaymentCheck = await conductor.qbd.salesTaxPaymentChecks.retrieve('123ABC-1234567890', { conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(salesTaxPaymentCheck);\n```",
|
|
7820
|
+
perLanguage: {
|
|
7821
|
+
typescript: {
|
|
7822
|
+
method: 'client.qbd.salesTaxPaymentChecks.retrieve',
|
|
7823
|
+
example: "import Conductor from 'conductor-node';\n\nconst conductor = new Conductor({\n apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted\n});\n\nconst salesTaxPaymentCheck = await conductor.qbd.salesTaxPaymentChecks.retrieve(\n '123ABC-1234567890',\n { conductorEndUserId: 'end_usr_1234567abcdefg' },\n);\n\nconsole.log(salesTaxPaymentCheck.id);",
|
|
7824
|
+
},
|
|
7825
|
+
python: {
|
|
7826
|
+
method: 'qbd.sales_tax_payment_checks.retrieve',
|
|
7827
|
+
example: 'import os\nfrom conductor import Conductor\n\nconductor = Conductor(\n api_key=os.environ.get("CONDUCTOR_SECRET_KEY"), # This is the default and can be omitted\n)\nsales_tax_payment_check = conductor.qbd.sales_tax_payment_checks.retrieve(\n id="123ABC-1234567890",\n conductor_end_user_id="end_usr_1234567abcdefg",\n)\nprint(sales_tax_payment_check.id)',
|
|
7828
|
+
},
|
|
7829
|
+
http: {
|
|
7830
|
+
example: 'curl https://api.conductor.is/v1/quickbooks-desktop/sales-tax-payment-checks/$ID \\\n -H "Authorization: Bearer $CONDUCTOR_SECRET_KEY"',
|
|
7831
|
+
},
|
|
7832
|
+
},
|
|
7833
|
+
},
|
|
7834
|
+
{
|
|
7835
|
+
name: 'update',
|
|
7836
|
+
endpoint: '/quickbooks-desktop/sales-tax-payment-checks/{id}',
|
|
7837
|
+
httpMethod: 'post',
|
|
7838
|
+
summary: 'Update a sales-tax payment check',
|
|
7839
|
+
description: 'Updates an existing sales-tax payment check.',
|
|
7840
|
+
stainlessPath: '(resource) qbd.sales_tax_payment_checks > (method) update',
|
|
7841
|
+
qualified: 'client.qbd.salesTaxPaymentChecks.update',
|
|
7842
|
+
params: [
|
|
7843
|
+
'id: string;',
|
|
7844
|
+
'revisionNumber: string;',
|
|
7845
|
+
'Conductor-End-User-Id: string;',
|
|
7846
|
+
'address?: { city?: string; country?: string; line1?: string; line2?: string; line3?: string; line4?: string; line5?: string; note?: string; postalCode?: string; state?: string; };',
|
|
7847
|
+
'bankAccountId?: string;',
|
|
7848
|
+
'isQueuedForPrint?: boolean;',
|
|
7849
|
+
'memo?: string;',
|
|
7850
|
+
'refNumber?: string;',
|
|
7851
|
+
'transactionDate?: string;',
|
|
7852
|
+
],
|
|
7853
|
+
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; }; }",
|
|
7854
|
+
markdown: "## update\n\n`conductor.qbd.salesTaxPaymentChecks.update(id: string, revisionNumber: string, Conductor-End-User-Id: string, address?: { city?: string; country?: string; line1?: string; line2?: string; line3?: string; line4?: string; line5?: string; note?: string; postalCode?: string; state?: string; }, bankAccountId?: string, isQueuedForPrint?: boolean, memo?: string, refNumber?: string, transactionDate?: 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**post** `/quickbooks-desktop/sales-tax-payment-checks/{id}`\n\nUpdates an existing sales-tax payment check.\n\n### Parameters\n\n- `id: string`\n The QuickBooks-assigned unique identifier of the sales-tax payment check to update.\n\n- `revisionNumber: string`\n The current QuickBooks-assigned revision number of the sales-tax payment check object you are updating, which you can get by fetching the object first. Provide the most recent `revisionNumber` to ensure you're working with the latest data; otherwise, the update will return an error.\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `address?: { city?: string; country?: string; line1?: string; line2?: string; line3?: string; line4?: string; line5?: string; note?: string; postalCode?: string; state?: string; }`\n The address that is printed on the sales-tax payment check.\n - `city?: string`\n The city, district, suburb, town, or village name of the address.\n\nMaximum length: 31 characters.\n - `country?: string`\n The country name of the address.\n - `line1?: string`\n The first line of the address (e.g., street, PO Box, or company name).\n\nMaximum length: 41 characters.\n - `line2?: string`\n The second line of the address, if needed (e.g., apartment, suite, unit, or building).\n\nMaximum length: 41 characters.\n - `line3?: string`\n The third line of the address, if needed.\n\nMaximum length: 41 characters.\n - `line4?: string`\n The fourth line of the address, if needed.\n\nMaximum length: 41 characters.\n - `line5?: string`\n The fifth line of the address, if needed.\n\nMaximum length: 41 characters.\n - `note?: string`\n A note written at the bottom of the address in the form in which it appears, such as the invoice form.\n - `postalCode?: string`\n The postal code or ZIP code of the address.\n\nMaximum length: 13 characters.\n - `state?: string`\n The state, county, province, or region name of the address.\n\nMaximum length: 21 characters.\n\n- `bankAccountId?: string`\n The bank account from which the funds are being drawn for this sales-tax payment check; e.g., Checking or Savings. This sales-tax payment check will decrease the balance of this account.\n\n- `isQueuedForPrint?: boolean`\n Indicates whether this sales-tax payment check is included in the queue of documents for QuickBooks to print.\n\n- `memo?: string`\n A memo or note for this sales-tax payment check.\n\n- `refNumber?: string`\n The case-sensitive user-defined reference number for this sales-tax payment check, which can be used to identify the transaction in QuickBooks. This value is not required to be unique and can be arbitrarily changed by the QuickBooks user.\n\n**IMPORTANT**: For checks, this field is the check number.\n\nMaximum length: 11 characters.\n\n- `transactionDate?: string`\n The date of this sales-tax payment check, in ISO 8601 format (YYYY-MM-DD).\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\nconst salesTaxPaymentCheck = await conductor.qbd.salesTaxPaymentChecks.update('123ABC-1234567890', { revisionNumber: '1721172183', conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(salesTaxPaymentCheck);\n```",
|
|
7855
|
+
perLanguage: {
|
|
7856
|
+
typescript: {
|
|
7857
|
+
method: 'client.qbd.salesTaxPaymentChecks.update',
|
|
7858
|
+
example: "import Conductor from 'conductor-node';\n\nconst conductor = new Conductor({\n apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted\n});\n\nconst salesTaxPaymentCheck = await conductor.qbd.salesTaxPaymentChecks.update('123ABC-1234567890', {\n revisionNumber: '1721172183',\n conductorEndUserId: 'end_usr_1234567abcdefg',\n});\n\nconsole.log(salesTaxPaymentCheck.id);",
|
|
7859
|
+
},
|
|
7860
|
+
python: {
|
|
7861
|
+
method: 'qbd.sales_tax_payment_checks.update',
|
|
7862
|
+
example: 'import os\nfrom conductor import Conductor\n\nconductor = Conductor(\n api_key=os.environ.get("CONDUCTOR_SECRET_KEY"), # This is the default and can be omitted\n)\nsales_tax_payment_check = conductor.qbd.sales_tax_payment_checks.update(\n id="123ABC-1234567890",\n revision_number="1721172183",\n conductor_end_user_id="end_usr_1234567abcdefg",\n)\nprint(sales_tax_payment_check.id)',
|
|
7863
|
+
},
|
|
7864
|
+
http: {
|
|
7865
|
+
example: 'curl https://api.conductor.is/v1/quickbooks-desktop/sales-tax-payment-checks/$ID \\\n -H \'Content-Type: application/json\' \\\n -H "Authorization: Bearer $CONDUCTOR_SECRET_KEY" \\\n -d \'{\n "revisionNumber": "1721172183",\n "bankAccountId": "80000001-1234567890",\n "isQueuedForPrint": true,\n "memo": "Sales tax payment for Q3 2024",\n "refNumber": "TAXPMT-1234",\n "transactionDate": "2024-10-01"\n }\'',
|
|
7866
|
+
},
|
|
7867
|
+
},
|
|
7868
|
+
},
|
|
7869
|
+
{
|
|
7870
|
+
name: 'void',
|
|
7871
|
+
endpoint: '/quickbooks-desktop/sales-tax-payment-checks/{id}/void',
|
|
7872
|
+
httpMethod: 'post',
|
|
7873
|
+
summary: 'Void a sales-tax payment check',
|
|
7874
|
+
description: 'Voids a sales-tax payment check by setting its amount to zero while keeping a record of it in QuickBooks. The void will fail if the sales-tax payment check is currently in use or has any linked transactions that are in use.',
|
|
7875
|
+
stainlessPath: '(resource) qbd.sales_tax_payment_checks > (method) void',
|
|
7876
|
+
qualified: 'client.qbd.salesTaxPaymentChecks.void',
|
|
7877
|
+
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
7878
|
+
response: "{ id: string; createdAt: string; objectType: 'qbd_sales_tax_payment_check'; refNumber: string; updatedAt: string; voided: boolean; }",
|
|
7879
|
+
markdown: "## void\n\n`conductor.qbd.salesTaxPaymentChecks.void(id: string, Conductor-End-User-Id: string): { id: string; createdAt: string; objectType: 'qbd_sales_tax_payment_check'; refNumber: string; updatedAt: string; voided: boolean; }`\n\n**post** `/quickbooks-desktop/sales-tax-payment-checks/{id}/void`\n\nVoids a sales-tax payment check by setting its amount to zero while keeping a record of it in QuickBooks. The void will fail if the sales-tax payment check is currently in use or has any linked transactions that are in use.\n\n### Parameters\n\n- `id: string`\n The QuickBooks-assigned unique identifier of the sales-tax payment check to void.\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n### Returns\n\n- `{ id: string; createdAt: string; objectType: 'qbd_sales_tax_payment_check'; refNumber: string; updatedAt: string; voided: boolean; }`\n\n - `id: string`\n - `createdAt: string`\n - `objectType: 'qbd_sales_tax_payment_check'`\n - `refNumber: string`\n - `updatedAt: string`\n - `voided: boolean`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst response = await conductor.qbd.salesTaxPaymentChecks.void('123ABC-1234567890', { conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(response);\n```",
|
|
7880
|
+
perLanguage: {
|
|
7881
|
+
typescript: {
|
|
7882
|
+
method: 'client.qbd.salesTaxPaymentChecks.void',
|
|
7883
|
+
example: "import Conductor from 'conductor-node';\n\nconst conductor = new Conductor({\n apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted\n});\n\nconst response = await conductor.qbd.salesTaxPaymentChecks.void('123ABC-1234567890', {\n conductorEndUserId: 'end_usr_1234567abcdefg',\n});\n\nconsole.log(response.id);",
|
|
7884
|
+
},
|
|
7885
|
+
python: {
|
|
7886
|
+
method: 'qbd.sales_tax_payment_checks.void',
|
|
7887
|
+
example: 'import os\nfrom conductor import Conductor\n\nconductor = Conductor(\n api_key=os.environ.get("CONDUCTOR_SECRET_KEY"), # This is the default and can be omitted\n)\nresponse = conductor.qbd.sales_tax_payment_checks.void(\n id="123ABC-1234567890",\n conductor_end_user_id="end_usr_1234567abcdefg",\n)\nprint(response.id)',
|
|
7888
|
+
},
|
|
7889
|
+
http: {
|
|
7890
|
+
example: 'curl https://api.conductor.is/v1/quickbooks-desktop/sales-tax-payment-checks/$ID/void \\\n -X POST \\\n -H "Authorization: Bearer $CONDUCTOR_SECRET_KEY"',
|
|
7891
|
+
},
|
|
7892
|
+
},
|
|
7893
|
+
},
|
|
7894
|
+
{
|
|
7895
|
+
name: 'delete',
|
|
7896
|
+
endpoint: '/quickbooks-desktop/sales-tax-payment-checks/{id}',
|
|
7897
|
+
httpMethod: 'delete',
|
|
7898
|
+
summary: 'Delete a sales-tax payment check',
|
|
7899
|
+
description: 'Permanently deletes a sales-tax payment check. The deletion will fail if the sales-tax payment check is currently in use or has any linked transactions that are in use.',
|
|
7900
|
+
stainlessPath: '(resource) qbd.sales_tax_payment_checks > (method) delete',
|
|
7901
|
+
qualified: 'client.qbd.salesTaxPaymentChecks.delete',
|
|
7902
|
+
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
7903
|
+
response: "{ id: string; deleted: boolean; objectType: 'qbd_sales_tax_payment_check'; refNumber: string; }",
|
|
7904
|
+
markdown: "## delete\n\n`conductor.qbd.salesTaxPaymentChecks.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_sales_tax_payment_check'; refNumber: string; }`\n\n**delete** `/quickbooks-desktop/sales-tax-payment-checks/{id}`\n\nPermanently deletes a sales-tax payment check. The deletion will fail if the sales-tax payment check is currently in use or has any linked transactions that are in use.\n\n### Parameters\n\n- `id: string`\n The QuickBooks-assigned unique identifier of the sales-tax payment check to delete.\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n### Returns\n\n- `{ id: string; deleted: boolean; objectType: 'qbd_sales_tax_payment_check'; refNumber: string; }`\n\n - `id: string`\n - `deleted: boolean`\n - `objectType: 'qbd_sales_tax_payment_check'`\n - `refNumber: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst salesTaxPaymentCheck = await conductor.qbd.salesTaxPaymentChecks.delete('123ABC-1234567890', { conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(salesTaxPaymentCheck);\n```",
|
|
7905
|
+
perLanguage: {
|
|
7906
|
+
typescript: {
|
|
7907
|
+
method: 'client.qbd.salesTaxPaymentChecks.delete',
|
|
7908
|
+
example: "import Conductor from 'conductor-node';\n\nconst conductor = new Conductor({\n apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted\n});\n\nconst salesTaxPaymentCheck = await conductor.qbd.salesTaxPaymentChecks.delete('123ABC-1234567890', {\n conductorEndUserId: 'end_usr_1234567abcdefg',\n});\n\nconsole.log(salesTaxPaymentCheck.id);",
|
|
7909
|
+
},
|
|
7910
|
+
python: {
|
|
7911
|
+
method: 'qbd.sales_tax_payment_checks.delete',
|
|
7912
|
+
example: 'import os\nfrom conductor import Conductor\n\nconductor = Conductor(\n api_key=os.environ.get("CONDUCTOR_SECRET_KEY"), # This is the default and can be omitted\n)\nsales_tax_payment_check = conductor.qbd.sales_tax_payment_checks.delete(\n id="123ABC-1234567890",\n conductor_end_user_id="end_usr_1234567abcdefg",\n)\nprint(sales_tax_payment_check.id)',
|
|
7913
|
+
},
|
|
7914
|
+
http: {
|
|
7915
|
+
example: 'curl https://api.conductor.is/v1/quickbooks-desktop/sales-tax-payment-checks/$ID \\\n -X DELETE \\\n -H "Authorization: Bearer $CONDUCTOR_SECRET_KEY"',
|
|
7916
|
+
},
|
|
7917
|
+
},
|
|
7918
|
+
},
|
|
7598
7919
|
{
|
|
7599
7920
|
name: 'create',
|
|
7600
7921
|
endpoint: '/quickbooks-desktop/service-items',
|
|
@@ -8213,12 +8534,12 @@ const EMBEDDED_METHODS = [
|
|
|
8213
8534
|
endpoint: '/quickbooks-desktop/time-tracking-activities/{id}',
|
|
8214
8535
|
httpMethod: 'delete',
|
|
8215
8536
|
summary: 'Delete a time tracking activity',
|
|
8216
|
-
description: 'Permanently deletes a
|
|
8537
|
+
description: 'Permanently deletes a time tracking activity. The deletion will fail if the time tracking activity is currently in use or has any linked transactions that are in use.',
|
|
8217
8538
|
stainlessPath: '(resource) qbd.time_tracking_activities > (method) delete',
|
|
8218
8539
|
qualified: 'client.qbd.timeTrackingActivities.delete',
|
|
8219
8540
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
8220
8541
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_time_tracking_activity'; }",
|
|
8221
|
-
markdown: "## delete\n\n`conductor.qbd.timeTrackingActivities.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_time_tracking_activity'; }`\n\n**delete** `/quickbooks-desktop/time-tracking-activities/{id}`\n\nPermanently deletes a
|
|
8542
|
+
markdown: "## delete\n\n`conductor.qbd.timeTrackingActivities.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_time_tracking_activity'; }`\n\n**delete** `/quickbooks-desktop/time-tracking-activities/{id}`\n\nPermanently deletes a time tracking activity. The deletion will fail if the time tracking activity is currently in use or has any linked transactions that are in use.\n\n### Parameters\n\n- `id: string`\n The QuickBooks-assigned unique identifier of the time tracking activity to delete.\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n### Returns\n\n- `{ id: string; deleted: boolean; objectType: 'qbd_time_tracking_activity'; }`\n\n - `id: string`\n - `deleted: boolean`\n - `objectType: 'qbd_time_tracking_activity'`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst timeTrackingActivity = await conductor.qbd.timeTrackingActivities.delete('123ABC-1234567890', { conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(timeTrackingActivity);\n```",
|
|
8222
8543
|
perLanguage: {
|
|
8223
8544
|
typescript: {
|
|
8224
8545
|
method: 'client.qbd.timeTrackingActivities.delete',
|
|
@@ -8709,12 +9030,12 @@ const EMBEDDED_METHODS = [
|
|
|
8709
9030
|
endpoint: '/quickbooks-desktop/vendor-credits/{id}',
|
|
8710
9031
|
httpMethod: 'delete',
|
|
8711
9032
|
summary: 'Delete a vendor credit',
|
|
8712
|
-
description: 'Permanently deletes a
|
|
9033
|
+
description: 'Permanently deletes a vendor credit. The deletion will fail if the vendor credit is currently in use or has any linked transactions that are in use.',
|
|
8713
9034
|
stainlessPath: '(resource) qbd.vendor_credits > (method) delete',
|
|
8714
9035
|
qualified: 'client.qbd.vendorCredits.delete',
|
|
8715
9036
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
8716
9037
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_vendor_credit'; refNumber: string; }",
|
|
8717
|
-
markdown: "## delete\n\n`conductor.qbd.vendorCredits.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_vendor_credit'; refNumber: string; }`\n\n**delete** `/quickbooks-desktop/vendor-credits/{id}`\n\nPermanently deletes a
|
|
9038
|
+
markdown: "## delete\n\n`conductor.qbd.vendorCredits.delete(id: string, Conductor-End-User-Id: string): { id: string; deleted: boolean; objectType: 'qbd_vendor_credit'; refNumber: string; }`\n\n**delete** `/quickbooks-desktop/vendor-credits/{id}`\n\nPermanently deletes a vendor credit. The deletion will fail if the vendor credit is currently in use or has any linked transactions that are in use.\n\n### Parameters\n\n- `id: string`\n The QuickBooks-assigned unique identifier of the vendor credit to delete.\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n### Returns\n\n- `{ id: string; deleted: boolean; objectType: 'qbd_vendor_credit'; refNumber: string; }`\n\n - `id: string`\n - `deleted: boolean`\n - `objectType: 'qbd_vendor_credit'`\n - `refNumber: string`\n\n### Example\n\n```typescript\nimport Conductor from 'conductor-node';\n\nconst client = new Conductor();\n\nconst vendorCredit = await conductor.qbd.vendorCredits.delete('123ABC-1234567890', { conductorEndUserId: 'end_usr_1234567abcdefg' });\n\nconsole.log(vendorCredit);\n```",
|
|
8718
9039
|
perLanguage: {
|
|
8719
9040
|
typescript: {
|
|
8720
9041
|
method: 'client.qbd.vendorCredits.delete',
|