conductor-node-mcp 14.19.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 +6 -0
- package/code-tool-worker.js.map +1 -1
- package/code-tool-worker.mjs +6 -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 +234 -44
- package/local-docs-search.js.map +1 -1
- package/local-docs-search.mjs +234 -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 +36 -0
- package/methods.js.map +1 -1
- package/methods.mjs +36 -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 +6 -0
- package/src/local-docs-search.ts +268 -44
- package/src/methods.ts +36 -0
- package/src/server.ts +1 -1
package/local-docs-search.mjs
CHANGED
|
@@ -138,12 +138,12 @@ const EMBEDDED_METHODS = [
|
|
|
138
138
|
endpoint: '/end-users/{id}/passthrough/{integrationSlug}',
|
|
139
139
|
httpMethod: 'post',
|
|
140
140
|
summary: 'Passthrough',
|
|
141
|
-
description:
|
|
141
|
+
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).",
|
|
142
142
|
stainlessPath: '(resource) end_users > (method) passthrough',
|
|
143
143
|
qualified: 'client.endUsers.passthrough',
|
|
144
144
|
params: ['id: string;', "integrationSlug: 'quickbooks_desktop';", 'qbd_payload: object;'],
|
|
145
145
|
response: 'object',
|
|
146
|
-
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\
|
|
146
|
+
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```",
|
|
147
147
|
perLanguage: {
|
|
148
148
|
typescript: {
|
|
149
149
|
method: 'client.endUsers.passthrough',
|
|
@@ -526,12 +526,12 @@ const EMBEDDED_METHODS = [
|
|
|
526
526
|
endpoint: '/quickbooks-desktop/bill-check-payments/{id}',
|
|
527
527
|
httpMethod: 'delete',
|
|
528
528
|
summary: 'Delete a bill check payment',
|
|
529
|
-
description: 'Permanently deletes a
|
|
529
|
+
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.',
|
|
530
530
|
stainlessPath: '(resource) qbd.bill_check_payments > (method) delete',
|
|
531
531
|
qualified: 'client.qbd.billCheckPayments.delete',
|
|
532
532
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
533
533
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_bill_check_payment'; refNumber: string; }",
|
|
534
|
-
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
|
|
534
|
+
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```",
|
|
535
535
|
perLanguage: {
|
|
536
536
|
typescript: {
|
|
537
537
|
method: 'client.qbd.billCheckPayments.delete',
|
|
@@ -681,12 +681,12 @@ const EMBEDDED_METHODS = [
|
|
|
681
681
|
endpoint: '/quickbooks-desktop/bill-credit-card-payments/{id}',
|
|
682
682
|
httpMethod: 'delete',
|
|
683
683
|
summary: 'Delete a bill credit card payment',
|
|
684
|
-
description: 'Permanently deletes a
|
|
684
|
+
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.',
|
|
685
685
|
stainlessPath: '(resource) qbd.bill_credit_card_payments > (method) delete',
|
|
686
686
|
qualified: 'client.qbd.billCreditCardPayments.delete',
|
|
687
687
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
688
688
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_bill_credit_card_payment'; refNumber: string; }",
|
|
689
|
-
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
|
|
689
|
+
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```",
|
|
690
690
|
perLanguage: {
|
|
691
691
|
typescript: {
|
|
692
692
|
method: 'client.qbd.billCreditCardPayments.delete',
|
|
@@ -888,12 +888,12 @@ const EMBEDDED_METHODS = [
|
|
|
888
888
|
endpoint: '/quickbooks-desktop/bills/{id}',
|
|
889
889
|
httpMethod: 'delete',
|
|
890
890
|
summary: 'Delete a bill',
|
|
891
|
-
description: 'Permanently deletes a
|
|
891
|
+
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.',
|
|
892
892
|
stainlessPath: '(resource) qbd.bills > (method) delete',
|
|
893
893
|
qualified: 'client.qbd.bills.delete',
|
|
894
894
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
895
895
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_bill'; refNumber: string; }",
|
|
896
|
-
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
|
|
896
|
+
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```",
|
|
897
897
|
perLanguage: {
|
|
898
898
|
typescript: {
|
|
899
899
|
method: 'client.qbd.bills.delete',
|
|
@@ -1091,12 +1091,12 @@ const EMBEDDED_METHODS = [
|
|
|
1091
1091
|
endpoint: '/quickbooks-desktop/build-assemblies/{id}',
|
|
1092
1092
|
httpMethod: 'delete',
|
|
1093
1093
|
summary: 'Delete a build assembly',
|
|
1094
|
-
description: 'Permanently deletes a
|
|
1094
|
+
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.',
|
|
1095
1095
|
stainlessPath: '(resource) qbd.build_assemblies > (method) delete',
|
|
1096
1096
|
qualified: 'client.qbd.buildAssemblies.delete',
|
|
1097
1097
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
1098
1098
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_build_assembly'; refNumber: string; }",
|
|
1099
|
-
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
|
|
1099
|
+
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```",
|
|
1100
1100
|
perLanguage: {
|
|
1101
1101
|
typescript: {
|
|
1102
1102
|
method: 'client.qbd.buildAssemblies.delete',
|
|
@@ -1296,12 +1296,12 @@ const EMBEDDED_METHODS = [
|
|
|
1296
1296
|
endpoint: '/quickbooks-desktop/checks/{id}',
|
|
1297
1297
|
httpMethod: 'delete',
|
|
1298
1298
|
summary: 'Delete a check',
|
|
1299
|
-
description: 'Permanently deletes a
|
|
1299
|
+
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.',
|
|
1300
1300
|
stainlessPath: '(resource) qbd.checks > (method) delete',
|
|
1301
1301
|
qualified: 'client.qbd.checks.delete',
|
|
1302
1302
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
1303
1303
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_check'; refNumber: string; }",
|
|
1304
|
-
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
|
|
1304
|
+
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```",
|
|
1305
1305
|
perLanguage: {
|
|
1306
1306
|
typescript: {
|
|
1307
1307
|
method: 'client.qbd.checks.delete',
|
|
@@ -1639,12 +1639,12 @@ const EMBEDDED_METHODS = [
|
|
|
1639
1639
|
endpoint: '/quickbooks-desktop/credit-card-charges/{id}',
|
|
1640
1640
|
httpMethod: 'delete',
|
|
1641
1641
|
summary: 'Delete a credit card charge',
|
|
1642
|
-
description: 'Permanently deletes a
|
|
1642
|
+
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.',
|
|
1643
1643
|
stainlessPath: '(resource) qbd.credit_card_charges > (method) delete',
|
|
1644
1644
|
qualified: 'client.qbd.creditCardCharges.delete',
|
|
1645
1645
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
1646
1646
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_credit_card_charge'; refNumber: string; }",
|
|
1647
|
-
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
|
|
1647
|
+
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```",
|
|
1648
1648
|
perLanguage: {
|
|
1649
1649
|
typescript: {
|
|
1650
1650
|
method: 'client.qbd.creditCardCharges.delete',
|
|
@@ -1837,12 +1837,12 @@ const EMBEDDED_METHODS = [
|
|
|
1837
1837
|
endpoint: '/quickbooks-desktop/credit-card-credits/{id}',
|
|
1838
1838
|
httpMethod: 'delete',
|
|
1839
1839
|
summary: 'Delete a credit card credit',
|
|
1840
|
-
description: 'Permanently deletes a
|
|
1840
|
+
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.',
|
|
1841
1841
|
stainlessPath: '(resource) qbd.credit_card_credits > (method) delete',
|
|
1842
1842
|
qualified: 'client.qbd.creditCardCredits.delete',
|
|
1843
1843
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
1844
1844
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_credit_card_credit'; refNumber: string; }",
|
|
1845
|
-
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
|
|
1845
|
+
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```",
|
|
1846
1846
|
perLanguage: {
|
|
1847
1847
|
typescript: {
|
|
1848
1848
|
method: 'client.qbd.creditCardCredits.delete',
|
|
@@ -1995,12 +1995,12 @@ const EMBEDDED_METHODS = [
|
|
|
1995
1995
|
endpoint: '/quickbooks-desktop/credit-card-refunds/{id}',
|
|
1996
1996
|
httpMethod: 'delete',
|
|
1997
1997
|
summary: 'Delete a credit card refund',
|
|
1998
|
-
description: 'Permanently deletes a
|
|
1998
|
+
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.',
|
|
1999
1999
|
stainlessPath: '(resource) qbd.credit_card_refunds > (method) delete',
|
|
2000
2000
|
qualified: 'client.qbd.creditCardRefunds.delete',
|
|
2001
2001
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
2002
2002
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_credit_card_refund'; refNumber: string; }",
|
|
2003
|
-
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
|
|
2003
|
+
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```",
|
|
2004
2004
|
perLanguage: {
|
|
2005
2005
|
typescript: {
|
|
2006
2006
|
method: 'client.qbd.creditCardRefunds.delete',
|
|
@@ -2224,12 +2224,12 @@ const EMBEDDED_METHODS = [
|
|
|
2224
2224
|
endpoint: '/quickbooks-desktop/credit-memos/{id}',
|
|
2225
2225
|
httpMethod: 'delete',
|
|
2226
2226
|
summary: 'Delete a credit memo',
|
|
2227
|
-
description: 'Permanently deletes a
|
|
2227
|
+
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.',
|
|
2228
2228
|
stainlessPath: '(resource) qbd.credit_memos > (method) delete',
|
|
2229
2229
|
qualified: 'client.qbd.creditMemos.delete',
|
|
2230
2230
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
2231
2231
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_credit_memo'; refNumber: string; }",
|
|
2232
|
-
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
|
|
2232
|
+
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```",
|
|
2233
2233
|
perLanguage: {
|
|
2234
2234
|
typescript: {
|
|
2235
2235
|
method: 'client.qbd.creditMemos.delete',
|
|
@@ -3000,12 +3000,12 @@ const EMBEDDED_METHODS = [
|
|
|
3000
3000
|
endpoint: '/quickbooks-desktop/deposits/{id}',
|
|
3001
3001
|
httpMethod: 'delete',
|
|
3002
3002
|
summary: 'Delete a deposit',
|
|
3003
|
-
description: 'Permanently deletes a
|
|
3003
|
+
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.',
|
|
3004
3004
|
stainlessPath: '(resource) qbd.deposits > (method) delete',
|
|
3005
3005
|
qualified: 'client.qbd.deposits.delete',
|
|
3006
3006
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
3007
3007
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_deposit'; }",
|
|
3008
|
-
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
|
|
3008
|
+
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```",
|
|
3009
3009
|
perLanguage: {
|
|
3010
3010
|
typescript: {
|
|
3011
3011
|
method: 'client.qbd.deposits.delete',
|
|
@@ -3548,12 +3548,12 @@ const EMBEDDED_METHODS = [
|
|
|
3548
3548
|
endpoint: '/quickbooks-desktop/estimates/{id}',
|
|
3549
3549
|
httpMethod: 'delete',
|
|
3550
3550
|
summary: 'Delete an estimate',
|
|
3551
|
-
description: 'Permanently deletes
|
|
3551
|
+
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.',
|
|
3552
3552
|
stainlessPath: '(resource) qbd.estimates > (method) delete',
|
|
3553
3553
|
qualified: 'client.qbd.estimates.delete',
|
|
3554
3554
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
3555
3555
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_estimate'; refNumber: string; }",
|
|
3556
|
-
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
|
|
3556
|
+
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```",
|
|
3557
3557
|
perLanguage: {
|
|
3558
3558
|
typescript: {
|
|
3559
3559
|
method: 'client.qbd.estimates.delete',
|
|
@@ -3739,12 +3739,12 @@ const EMBEDDED_METHODS = [
|
|
|
3739
3739
|
endpoint: '/quickbooks-desktop/inventory-adjustments/{id}',
|
|
3740
3740
|
httpMethod: 'delete',
|
|
3741
3741
|
summary: 'Delete an inventory adjustment',
|
|
3742
|
-
description: 'Permanently deletes
|
|
3742
|
+
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.',
|
|
3743
3743
|
stainlessPath: '(resource) qbd.inventory_adjustments > (method) delete',
|
|
3744
3744
|
qualified: 'client.qbd.inventoryAdjustments.delete',
|
|
3745
3745
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
3746
3746
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_inventory_adjustment'; refNumber: string; }",
|
|
3747
|
-
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
|
|
3747
|
+
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```",
|
|
3748
3748
|
perLanguage: {
|
|
3749
3749
|
typescript: {
|
|
3750
3750
|
method: 'client.qbd.inventoryAdjustments.delete',
|
|
@@ -4439,12 +4439,12 @@ const EMBEDDED_METHODS = [
|
|
|
4439
4439
|
endpoint: '/quickbooks-desktop/invoices/{id}',
|
|
4440
4440
|
httpMethod: 'delete',
|
|
4441
4441
|
summary: 'Delete an invoice',
|
|
4442
|
-
description: 'Permanently deletes
|
|
4442
|
+
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.',
|
|
4443
4443
|
stainlessPath: '(resource) qbd.invoices > (method) delete',
|
|
4444
4444
|
qualified: 'client.qbd.invoices.delete',
|
|
4445
4445
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
4446
4446
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_invoice'; refNumber: string; }",
|
|
4447
|
-
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
|
|
4447
|
+
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```",
|
|
4448
4448
|
perLanguage: {
|
|
4449
4449
|
typescript: {
|
|
4450
4450
|
method: 'client.qbd.invoices.delete',
|
|
@@ -4776,12 +4776,12 @@ const EMBEDDED_METHODS = [
|
|
|
4776
4776
|
endpoint: '/quickbooks-desktop/item-receipts/{id}',
|
|
4777
4777
|
httpMethod: 'delete',
|
|
4778
4778
|
summary: 'Delete an item receipt',
|
|
4779
|
-
description: 'Permanently deletes
|
|
4779
|
+
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.',
|
|
4780
4780
|
stainlessPath: '(resource) qbd.item_receipts > (method) delete',
|
|
4781
4781
|
qualified: 'client.qbd.itemReceipts.delete',
|
|
4782
4782
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
4783
4783
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_item_receipt'; refNumber: string; }",
|
|
4784
|
-
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
|
|
4784
|
+
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```",
|
|
4785
4785
|
perLanguage: {
|
|
4786
4786
|
typescript: {
|
|
4787
4787
|
method: 'client.qbd.itemReceipts.delete',
|
|
@@ -5027,12 +5027,12 @@ const EMBEDDED_METHODS = [
|
|
|
5027
5027
|
endpoint: '/quickbooks-desktop/journal-entries/{id}',
|
|
5028
5028
|
httpMethod: 'delete',
|
|
5029
5029
|
summary: 'Delete a journal entry',
|
|
5030
|
-
description: 'Permanently deletes a
|
|
5030
|
+
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.',
|
|
5031
5031
|
stainlessPath: '(resource) qbd.journal_entries > (method) delete',
|
|
5032
5032
|
qualified: 'client.qbd.journalEntries.delete',
|
|
5033
5033
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
5034
5034
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_journal_entry'; refNumber: string; }",
|
|
5035
|
-
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
|
|
5035
|
+
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```",
|
|
5036
5036
|
perLanguage: {
|
|
5037
5037
|
typescript: {
|
|
5038
5038
|
method: 'client.qbd.journalEntries.delete',
|
|
@@ -6034,12 +6034,12 @@ const EMBEDDED_METHODS = [
|
|
|
6034
6034
|
endpoint: '/quickbooks-desktop/purchase-orders/{id}',
|
|
6035
6035
|
httpMethod: 'delete',
|
|
6036
6036
|
summary: 'Delete a purchase order',
|
|
6037
|
-
description: 'Permanently deletes a
|
|
6037
|
+
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.',
|
|
6038
6038
|
stainlessPath: '(resource) qbd.purchase_orders > (method) delete',
|
|
6039
6039
|
qualified: 'client.qbd.purchaseOrders.delete',
|
|
6040
6040
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
6041
6041
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_purchase_order'; refNumber: string; }",
|
|
6042
|
-
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
|
|
6042
|
+
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```",
|
|
6043
6043
|
perLanguage: {
|
|
6044
6044
|
typescript: {
|
|
6045
6045
|
method: 'client.qbd.purchaseOrders.delete',
|
|
@@ -6208,12 +6208,12 @@ const EMBEDDED_METHODS = [
|
|
|
6208
6208
|
endpoint: '/quickbooks-desktop/receive-payments/{id}',
|
|
6209
6209
|
httpMethod: 'delete',
|
|
6210
6210
|
summary: 'Delete a receive-payment',
|
|
6211
|
-
description: 'Permanently deletes a
|
|
6211
|
+
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.',
|
|
6212
6212
|
stainlessPath: '(resource) qbd.receive_payments > (method) delete',
|
|
6213
6213
|
qualified: 'client.qbd.receivePayments.delete',
|
|
6214
6214
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
6215
6215
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_receive_payment'; refNumber: string; }",
|
|
6216
|
-
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
|
|
6216
|
+
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```",
|
|
6217
6217
|
perLanguage: {
|
|
6218
6218
|
typescript: {
|
|
6219
6219
|
method: 'client.qbd.receivePayments.delete',
|
|
@@ -6915,12 +6915,12 @@ const EMBEDDED_METHODS = [
|
|
|
6915
6915
|
endpoint: '/quickbooks-desktop/sales-orders/{id}',
|
|
6916
6916
|
httpMethod: 'delete',
|
|
6917
6917
|
summary: 'Delete a sales order',
|
|
6918
|
-
description: 'Permanently deletes a
|
|
6918
|
+
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.',
|
|
6919
6919
|
stainlessPath: '(resource) qbd.sales_orders > (method) delete',
|
|
6920
6920
|
qualified: 'client.qbd.salesOrders.delete',
|
|
6921
6921
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
6922
6922
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_sales_order'; refNumber: string; }",
|
|
6923
|
-
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
|
|
6923
|
+
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```",
|
|
6924
6924
|
perLanguage: {
|
|
6925
6925
|
typescript: {
|
|
6926
6926
|
method: 'client.qbd.salesOrders.delete',
|
|
@@ -7144,12 +7144,12 @@ const EMBEDDED_METHODS = [
|
|
|
7144
7144
|
endpoint: '/quickbooks-desktop/sales-receipts/{id}',
|
|
7145
7145
|
httpMethod: 'delete',
|
|
7146
7146
|
summary: 'Delete a sales receipt',
|
|
7147
|
-
description: 'Permanently deletes a
|
|
7147
|
+
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.',
|
|
7148
7148
|
stainlessPath: '(resource) qbd.sales_receipts > (method) delete',
|
|
7149
7149
|
qualified: 'client.qbd.salesReceipts.delete',
|
|
7150
7150
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
7151
7151
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_sales_receipt'; refNumber: string; }",
|
|
7152
|
-
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
|
|
7152
|
+
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```",
|
|
7153
7153
|
perLanguage: {
|
|
7154
7154
|
typescript: {
|
|
7155
7155
|
method: 'client.qbd.salesReceipts.delete',
|
|
@@ -7687,6 +7687,196 @@ const EMBEDDED_METHODS = [
|
|
|
7687
7687
|
},
|
|
7688
7688
|
},
|
|
7689
7689
|
},
|
|
7690
|
+
{
|
|
7691
|
+
name: 'create',
|
|
7692
|
+
endpoint: '/quickbooks-desktop/sales-tax-payment-checks',
|
|
7693
|
+
httpMethod: 'post',
|
|
7694
|
+
summary: 'Create a sales-tax payment check',
|
|
7695
|
+
description: 'Creates a new sales-tax payment check.',
|
|
7696
|
+
stainlessPath: '(resource) qbd.sales_tax_payment_checks > (method) create',
|
|
7697
|
+
qualified: 'client.qbd.salesTaxPaymentChecks.create',
|
|
7698
|
+
params: [
|
|
7699
|
+
'bankAccountId: string;',
|
|
7700
|
+
'lines: { amount: string; salesTaxItemId?: string; }[];',
|
|
7701
|
+
'transactionDate: string;',
|
|
7702
|
+
'vendorId: string;',
|
|
7703
|
+
'Conductor-End-User-Id: string;',
|
|
7704
|
+
'address?: { city?: string; country?: string; line1?: string; line2?: string; line3?: string; line4?: string; line5?: string; note?: string; postalCode?: string; state?: string; };',
|
|
7705
|
+
'externalId?: string;',
|
|
7706
|
+
'isQueuedForPrint?: boolean;',
|
|
7707
|
+
'memo?: string;',
|
|
7708
|
+
'refNumber?: string;',
|
|
7709
|
+
],
|
|
7710
|
+
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; }; }",
|
|
7711
|
+
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```",
|
|
7712
|
+
perLanguage: {
|
|
7713
|
+
typescript: {
|
|
7714
|
+
method: 'client.qbd.salesTaxPaymentChecks.create',
|
|
7715
|
+
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);",
|
|
7716
|
+
},
|
|
7717
|
+
python: {
|
|
7718
|
+
method: 'qbd.sales_tax_payment_checks.create',
|
|
7719
|
+
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)',
|
|
7720
|
+
},
|
|
7721
|
+
http: {
|
|
7722
|
+
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 }\'',
|
|
7723
|
+
},
|
|
7724
|
+
},
|
|
7725
|
+
},
|
|
7726
|
+
{
|
|
7727
|
+
name: 'list',
|
|
7728
|
+
endpoint: '/quickbooks-desktop/sales-tax-payment-checks',
|
|
7729
|
+
httpMethod: 'get',
|
|
7730
|
+
summary: 'List all sales-tax payment checks',
|
|
7731
|
+
description: 'Returns a list of sales-tax payment checks. Use the `cursor` parameter to paginate through the results.',
|
|
7732
|
+
stainlessPath: '(resource) qbd.sales_tax_payment_checks > (method) list',
|
|
7733
|
+
qualified: 'client.qbd.salesTaxPaymentChecks.list',
|
|
7734
|
+
params: [
|
|
7735
|
+
'Conductor-End-User-Id: string;',
|
|
7736
|
+
'accountIds?: string[];',
|
|
7737
|
+
'cursor?: string;',
|
|
7738
|
+
'ids?: string[];',
|
|
7739
|
+
'includeLineItems?: boolean;',
|
|
7740
|
+
'itemIds?: string[];',
|
|
7741
|
+
'limit?: number;',
|
|
7742
|
+
'refNumberContains?: string;',
|
|
7743
|
+
'refNumberEndsWith?: string;',
|
|
7744
|
+
'refNumberFrom?: string;',
|
|
7745
|
+
'refNumbers?: string[];',
|
|
7746
|
+
'refNumberStartsWith?: string;',
|
|
7747
|
+
'refNumberTo?: string;',
|
|
7748
|
+
'transactionDateFrom?: string;',
|
|
7749
|
+
'transactionDateTo?: string;',
|
|
7750
|
+
'updatedAfter?: string;',
|
|
7751
|
+
'updatedBefore?: string;',
|
|
7752
|
+
'vendorIds?: string[];',
|
|
7753
|
+
],
|
|
7754
|
+
response: "{ id: string; address: { city: string; country: string; line1: string; line2: string; line3: string; line4: string; line5: string; note: string; postalCode: string; state: string; }; amount: string; bankAccount: { id: string; fullName: string; }; createdAt: string; customFields: { name: string; ownerId: string; type: string; value: string; }[]; externalId: string; isQueuedForPrint: boolean; lines: { id: string; amount: string; objectType: 'qbd_sales_tax_payment_check_line'; salesTaxItem: { id: string; fullName: string; }; taxAmount: string; }[]; memo: string; objectType: 'qbd_sales_tax_payment_check'; refNumber: string; revisionNumber: string; transactionDate: string; updatedAt: string; vendor: { id: string; fullName: string; }; }",
|
|
7755
|
+
markdown: "## list\n\n`conductor.qbd.salesTaxPaymentChecks.list(Conductor-End-User-Id: string, accountIds?: string[], cursor?: string, ids?: string[], includeLineItems?: boolean, itemIds?: string[], limit?: number, refNumberContains?: string, refNumberEndsWith?: string, refNumberFrom?: string, refNumbers?: string[], refNumberStartsWith?: string, refNumberTo?: string, transactionDateFrom?: string, transactionDateTo?: string, updatedAfter?: string, updatedBefore?: string, vendorIds?: string[]): { id: string; address: object; amount: string; bankAccount: object; createdAt: string; customFields: object[]; externalId: string; isQueuedForPrint: boolean; lines: object[]; memo: string; objectType: 'qbd_sales_tax_payment_check'; refNumber: string; revisionNumber: string; transactionDate: string; updatedAt: string; vendor: object; }`\n\n**get** `/quickbooks-desktop/sales-tax-payment-checks`\n\nReturns a list of sales-tax payment checks. Use the `cursor` parameter to paginate through the results.\n\n### Parameters\n\n- `Conductor-End-User-Id: string`\n The ID of the End-User to receive this request.\n\n- `accountIds?: string[]`\n Filter for sales-tax payment checks associated with these accounts.\n\n- `cursor?: string`\n The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results.\n\n- `ids?: string[]`\n Filter for specific sales-tax payment checks by their QuickBooks-assigned unique identifier(s).\n\n**IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request.\n\n**NOTE**: If any of the values you specify in this parameter are not found, the request will return an error.\n\n- `includeLineItems?: boolean`\n Whether to include line items in the response. Defaults to `true`.\n\n- `itemIds?: string[]`\n Filter for sales-tax payment checks containing these items.\n\n- `limit?: number`\n The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results.\n\n- `refNumberContains?: string`\n Filter for sales-tax payment checks whose `refNumber` contains this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`.\n\n- `refNumberEndsWith?: string`\n Filter for sales-tax payment checks whose `refNumber` ends with this substring.\n\n**NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`.\n\n- `refNumberFrom?: string`\n Filter for sales-tax payment checks whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison.\n\n- `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```",
|
|
7756
|
+
perLanguage: {
|
|
7757
|
+
typescript: {
|
|
7758
|
+
method: 'client.qbd.salesTaxPaymentChecks.list',
|
|
7759
|
+
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}",
|
|
7760
|
+
},
|
|
7761
|
+
python: {
|
|
7762
|
+
method: 'qbd.sales_tax_payment_checks.list',
|
|
7763
|
+
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)',
|
|
7764
|
+
},
|
|
7765
|
+
http: {
|
|
7766
|
+
example: 'curl https://api.conductor.is/v1/quickbooks-desktop/sales-tax-payment-checks \\\n -H "Authorization: Bearer $CONDUCTOR_SECRET_KEY"',
|
|
7767
|
+
},
|
|
7768
|
+
},
|
|
7769
|
+
},
|
|
7770
|
+
{
|
|
7771
|
+
name: 'retrieve',
|
|
7772
|
+
endpoint: '/quickbooks-desktop/sales-tax-payment-checks/{id}',
|
|
7773
|
+
httpMethod: 'get',
|
|
7774
|
+
summary: 'Retrieve a sales-tax payment check',
|
|
7775
|
+
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.',
|
|
7776
|
+
stainlessPath: '(resource) qbd.sales_tax_payment_checks > (method) retrieve',
|
|
7777
|
+
qualified: 'client.qbd.salesTaxPaymentChecks.retrieve',
|
|
7778
|
+
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
7779
|
+
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; }; }",
|
|
7780
|
+
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```",
|
|
7781
|
+
perLanguage: {
|
|
7782
|
+
typescript: {
|
|
7783
|
+
method: 'client.qbd.salesTaxPaymentChecks.retrieve',
|
|
7784
|
+
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);",
|
|
7785
|
+
},
|
|
7786
|
+
python: {
|
|
7787
|
+
method: 'qbd.sales_tax_payment_checks.retrieve',
|
|
7788
|
+
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)',
|
|
7789
|
+
},
|
|
7790
|
+
http: {
|
|
7791
|
+
example: 'curl https://api.conductor.is/v1/quickbooks-desktop/sales-tax-payment-checks/$ID \\\n -H "Authorization: Bearer $CONDUCTOR_SECRET_KEY"',
|
|
7792
|
+
},
|
|
7793
|
+
},
|
|
7794
|
+
},
|
|
7795
|
+
{
|
|
7796
|
+
name: 'update',
|
|
7797
|
+
endpoint: '/quickbooks-desktop/sales-tax-payment-checks/{id}',
|
|
7798
|
+
httpMethod: 'post',
|
|
7799
|
+
summary: 'Update a sales-tax payment check',
|
|
7800
|
+
description: 'Updates an existing sales-tax payment check.',
|
|
7801
|
+
stainlessPath: '(resource) qbd.sales_tax_payment_checks > (method) update',
|
|
7802
|
+
qualified: 'client.qbd.salesTaxPaymentChecks.update',
|
|
7803
|
+
params: [
|
|
7804
|
+
'id: string;',
|
|
7805
|
+
'revisionNumber: string;',
|
|
7806
|
+
'Conductor-End-User-Id: string;',
|
|
7807
|
+
'address?: { city?: string; country?: string; line1?: string; line2?: string; line3?: string; line4?: string; line5?: string; note?: string; postalCode?: string; state?: string; };',
|
|
7808
|
+
'bankAccountId?: string;',
|
|
7809
|
+
'isQueuedForPrint?: boolean;',
|
|
7810
|
+
'memo?: string;',
|
|
7811
|
+
'refNumber?: string;',
|
|
7812
|
+
'transactionDate?: string;',
|
|
7813
|
+
],
|
|
7814
|
+
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; }; }",
|
|
7815
|
+
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```",
|
|
7816
|
+
perLanguage: {
|
|
7817
|
+
typescript: {
|
|
7818
|
+
method: 'client.qbd.salesTaxPaymentChecks.update',
|
|
7819
|
+
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);",
|
|
7820
|
+
},
|
|
7821
|
+
python: {
|
|
7822
|
+
method: 'qbd.sales_tax_payment_checks.update',
|
|
7823
|
+
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)',
|
|
7824
|
+
},
|
|
7825
|
+
http: {
|
|
7826
|
+
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 }\'',
|
|
7827
|
+
},
|
|
7828
|
+
},
|
|
7829
|
+
},
|
|
7830
|
+
{
|
|
7831
|
+
name: 'void',
|
|
7832
|
+
endpoint: '/quickbooks-desktop/sales-tax-payment-checks/{id}/void',
|
|
7833
|
+
httpMethod: 'post',
|
|
7834
|
+
summary: 'Void a sales-tax payment check',
|
|
7835
|
+
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.',
|
|
7836
|
+
stainlessPath: '(resource) qbd.sales_tax_payment_checks > (method) void',
|
|
7837
|
+
qualified: 'client.qbd.salesTaxPaymentChecks.void',
|
|
7838
|
+
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
7839
|
+
response: "{ id: string; createdAt: string; objectType: 'qbd_sales_tax_payment_check'; refNumber: string; updatedAt: string; voided: boolean; }",
|
|
7840
|
+
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```",
|
|
7841
|
+
perLanguage: {
|
|
7842
|
+
typescript: {
|
|
7843
|
+
method: 'client.qbd.salesTaxPaymentChecks.void',
|
|
7844
|
+
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);",
|
|
7845
|
+
},
|
|
7846
|
+
python: {
|
|
7847
|
+
method: 'qbd.sales_tax_payment_checks.void',
|
|
7848
|
+
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)',
|
|
7849
|
+
},
|
|
7850
|
+
http: {
|
|
7851
|
+
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"',
|
|
7852
|
+
},
|
|
7853
|
+
},
|
|
7854
|
+
},
|
|
7855
|
+
{
|
|
7856
|
+
name: 'delete',
|
|
7857
|
+
endpoint: '/quickbooks-desktop/sales-tax-payment-checks/{id}',
|
|
7858
|
+
httpMethod: 'delete',
|
|
7859
|
+
summary: 'Delete a sales-tax payment check',
|
|
7860
|
+
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.',
|
|
7861
|
+
stainlessPath: '(resource) qbd.sales_tax_payment_checks > (method) delete',
|
|
7862
|
+
qualified: 'client.qbd.salesTaxPaymentChecks.delete',
|
|
7863
|
+
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
7864
|
+
response: "{ id: string; deleted: boolean; objectType: 'qbd_sales_tax_payment_check'; refNumber: string; }",
|
|
7865
|
+
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```",
|
|
7866
|
+
perLanguage: {
|
|
7867
|
+
typescript: {
|
|
7868
|
+
method: 'client.qbd.salesTaxPaymentChecks.delete',
|
|
7869
|
+
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);",
|
|
7870
|
+
},
|
|
7871
|
+
python: {
|
|
7872
|
+
method: 'qbd.sales_tax_payment_checks.delete',
|
|
7873
|
+
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)',
|
|
7874
|
+
},
|
|
7875
|
+
http: {
|
|
7876
|
+
example: 'curl https://api.conductor.is/v1/quickbooks-desktop/sales-tax-payment-checks/$ID \\\n -X DELETE \\\n -H "Authorization: Bearer $CONDUCTOR_SECRET_KEY"',
|
|
7877
|
+
},
|
|
7878
|
+
},
|
|
7879
|
+
},
|
|
7690
7880
|
{
|
|
7691
7881
|
name: 'create',
|
|
7692
7882
|
endpoint: '/quickbooks-desktop/service-items',
|
|
@@ -8305,12 +8495,12 @@ const EMBEDDED_METHODS = [
|
|
|
8305
8495
|
endpoint: '/quickbooks-desktop/time-tracking-activities/{id}',
|
|
8306
8496
|
httpMethod: 'delete',
|
|
8307
8497
|
summary: 'Delete a time tracking activity',
|
|
8308
|
-
description: 'Permanently deletes a
|
|
8498
|
+
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.',
|
|
8309
8499
|
stainlessPath: '(resource) qbd.time_tracking_activities > (method) delete',
|
|
8310
8500
|
qualified: 'client.qbd.timeTrackingActivities.delete',
|
|
8311
8501
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
8312
8502
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_time_tracking_activity'; }",
|
|
8313
|
-
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
|
|
8503
|
+
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```",
|
|
8314
8504
|
perLanguage: {
|
|
8315
8505
|
typescript: {
|
|
8316
8506
|
method: 'client.qbd.timeTrackingActivities.delete',
|
|
@@ -8801,12 +8991,12 @@ const EMBEDDED_METHODS = [
|
|
|
8801
8991
|
endpoint: '/quickbooks-desktop/vendor-credits/{id}',
|
|
8802
8992
|
httpMethod: 'delete',
|
|
8803
8993
|
summary: 'Delete a vendor credit',
|
|
8804
|
-
description: 'Permanently deletes a
|
|
8994
|
+
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.',
|
|
8805
8995
|
stainlessPath: '(resource) qbd.vendor_credits > (method) delete',
|
|
8806
8996
|
qualified: 'client.qbd.vendorCredits.delete',
|
|
8807
8997
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
8808
8998
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_vendor_credit'; refNumber: string; }",
|
|
8809
|
-
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
|
|
8999
|
+
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```",
|
|
8810
9000
|
perLanguage: {
|
|
8811
9001
|
typescript: {
|
|
8812
9002
|
method: 'client.qbd.vendorCredits.delete',
|