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/src/local-docs-search.ts
CHANGED
|
@@ -210,13 +210,13 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
210
210
|
httpMethod: 'post',
|
|
211
211
|
summary: 'Passthrough',
|
|
212
212
|
description:
|
|
213
|
-
|
|
213
|
+
"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).",
|
|
214
214
|
stainlessPath: '(resource) end_users > (method) passthrough',
|
|
215
215
|
qualified: 'client.endUsers.passthrough',
|
|
216
216
|
params: ['id: string;', "integrationSlug: 'quickbooks_desktop';", 'qbd_payload: object;'],
|
|
217
217
|
response: 'object',
|
|
218
218
|
markdown:
|
|
219
|
-
"## passthrough\n\n`conductor.endUsers.passthrough(id: string, integrationSlug: 'quickbooks_desktop', qbd_payload: object): object`\n\n**post** `/end-users/{id}/passthrough/{integrationSlug}`\n\
|
|
219
|
+
"## 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```",
|
|
220
220
|
perLanguage: {
|
|
221
221
|
typescript: {
|
|
222
222
|
method: 'client.endUsers.passthrough',
|
|
@@ -667,13 +667,13 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
667
667
|
httpMethod: 'delete',
|
|
668
668
|
summary: 'Delete a bill check payment',
|
|
669
669
|
description:
|
|
670
|
-
'Permanently deletes a
|
|
670
|
+
'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.',
|
|
671
671
|
stainlessPath: '(resource) qbd.bill_check_payments > (method) delete',
|
|
672
672
|
qualified: 'client.qbd.billCheckPayments.delete',
|
|
673
673
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
674
674
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_bill_check_payment'; refNumber: string; }",
|
|
675
675
|
markdown:
|
|
676
|
-
"## 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
|
|
676
|
+
"## 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```",
|
|
677
677
|
perLanguage: {
|
|
678
678
|
typescript: {
|
|
679
679
|
method: 'client.qbd.billCheckPayments.delete',
|
|
@@ -851,14 +851,14 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
851
851
|
httpMethod: 'delete',
|
|
852
852
|
summary: 'Delete a bill credit card payment',
|
|
853
853
|
description:
|
|
854
|
-
'Permanently deletes a
|
|
854
|
+
'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.',
|
|
855
855
|
stainlessPath: '(resource) qbd.bill_credit_card_payments > (method) delete',
|
|
856
856
|
qualified: 'client.qbd.billCreditCardPayments.delete',
|
|
857
857
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
858
858
|
response:
|
|
859
859
|
"{ id: string; deleted: boolean; objectType: 'qbd_bill_credit_card_payment'; refNumber: string; }",
|
|
860
860
|
markdown:
|
|
861
|
-
"## 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
|
|
861
|
+
"## 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```",
|
|
862
862
|
perLanguage: {
|
|
863
863
|
typescript: {
|
|
864
864
|
method: 'client.qbd.billCreditCardPayments.delete',
|
|
@@ -1093,13 +1093,13 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1093
1093
|
httpMethod: 'delete',
|
|
1094
1094
|
summary: 'Delete a bill',
|
|
1095
1095
|
description:
|
|
1096
|
-
'Permanently deletes a
|
|
1096
|
+
'Permanently deletes a bill. The deletion will fail if the bill is currently in use or has any linked transactions that are in use.',
|
|
1097
1097
|
stainlessPath: '(resource) qbd.bills > (method) delete',
|
|
1098
1098
|
qualified: 'client.qbd.bills.delete',
|
|
1099
1099
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
1100
1100
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_bill'; refNumber: string; }",
|
|
1101
1101
|
markdown:
|
|
1102
|
-
"## 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
|
|
1102
|
+
"## 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```",
|
|
1103
1103
|
perLanguage: {
|
|
1104
1104
|
typescript: {
|
|
1105
1105
|
method: 'client.qbd.bills.delete',
|
|
@@ -1329,13 +1329,13 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1329
1329
|
httpMethod: 'delete',
|
|
1330
1330
|
summary: 'Delete a build assembly',
|
|
1331
1331
|
description:
|
|
1332
|
-
'Permanently deletes a
|
|
1332
|
+
'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.',
|
|
1333
1333
|
stainlessPath: '(resource) qbd.build_assemblies > (method) delete',
|
|
1334
1334
|
qualified: 'client.qbd.buildAssemblies.delete',
|
|
1335
1335
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
1336
1336
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_build_assembly'; refNumber: string; }",
|
|
1337
1337
|
markdown:
|
|
1338
|
-
"## 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
|
|
1338
|
+
"## 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```",
|
|
1339
1339
|
perLanguage: {
|
|
1340
1340
|
typescript: {
|
|
1341
1341
|
method: 'client.qbd.buildAssemblies.delete',
|
|
@@ -1568,13 +1568,13 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1568
1568
|
httpMethod: 'delete',
|
|
1569
1569
|
summary: 'Delete a check',
|
|
1570
1570
|
description:
|
|
1571
|
-
'Permanently deletes a
|
|
1571
|
+
'Permanently deletes a check. The deletion will fail if the check is currently in use or has any linked transactions that are in use.',
|
|
1572
1572
|
stainlessPath: '(resource) qbd.checks > (method) delete',
|
|
1573
1573
|
qualified: 'client.qbd.checks.delete',
|
|
1574
1574
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
1575
1575
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_check'; refNumber: string; }",
|
|
1576
1576
|
markdown:
|
|
1577
|
-
"## 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
|
|
1577
|
+
"## 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```",
|
|
1578
1578
|
perLanguage: {
|
|
1579
1579
|
typescript: {
|
|
1580
1580
|
method: 'client.qbd.checks.delete',
|
|
@@ -1973,13 +1973,13 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
1973
1973
|
httpMethod: 'delete',
|
|
1974
1974
|
summary: 'Delete a credit card charge',
|
|
1975
1975
|
description:
|
|
1976
|
-
'Permanently deletes a
|
|
1976
|
+
'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.',
|
|
1977
1977
|
stainlessPath: '(resource) qbd.credit_card_charges > (method) delete',
|
|
1978
1978
|
qualified: 'client.qbd.creditCardCharges.delete',
|
|
1979
1979
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
1980
1980
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_credit_card_charge'; refNumber: string; }",
|
|
1981
1981
|
markdown:
|
|
1982
|
-
"## 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
|
|
1982
|
+
"## 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```",
|
|
1983
1983
|
perLanguage: {
|
|
1984
1984
|
typescript: {
|
|
1985
1985
|
method: 'client.qbd.creditCardCharges.delete',
|
|
@@ -2205,13 +2205,13 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2205
2205
|
httpMethod: 'delete',
|
|
2206
2206
|
summary: 'Delete a credit card credit',
|
|
2207
2207
|
description:
|
|
2208
|
-
'Permanently deletes a
|
|
2208
|
+
'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.',
|
|
2209
2209
|
stainlessPath: '(resource) qbd.credit_card_credits > (method) delete',
|
|
2210
2210
|
qualified: 'client.qbd.creditCardCredits.delete',
|
|
2211
2211
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
2212
2212
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_credit_card_credit'; refNumber: string; }",
|
|
2213
2213
|
markdown:
|
|
2214
|
-
"## 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
|
|
2214
|
+
"## 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```",
|
|
2215
2215
|
perLanguage: {
|
|
2216
2216
|
typescript: {
|
|
2217
2217
|
method: 'client.qbd.creditCardCredits.delete',
|
|
@@ -2392,13 +2392,13 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2392
2392
|
httpMethod: 'delete',
|
|
2393
2393
|
summary: 'Delete a credit card refund',
|
|
2394
2394
|
description:
|
|
2395
|
-
'Permanently deletes a
|
|
2395
|
+
'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.',
|
|
2396
2396
|
stainlessPath: '(resource) qbd.credit_card_refunds > (method) delete',
|
|
2397
2397
|
qualified: 'client.qbd.creditCardRefunds.delete',
|
|
2398
2398
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
2399
2399
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_credit_card_refund'; refNumber: string; }",
|
|
2400
2400
|
markdown:
|
|
2401
|
-
"## 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
|
|
2401
|
+
"## 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```",
|
|
2402
2402
|
perLanguage: {
|
|
2403
2403
|
typescript: {
|
|
2404
2404
|
method: 'client.qbd.creditCardRefunds.delete',
|
|
@@ -2655,13 +2655,13 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
2655
2655
|
httpMethod: 'delete',
|
|
2656
2656
|
summary: 'Delete a credit memo',
|
|
2657
2657
|
description:
|
|
2658
|
-
'Permanently deletes a
|
|
2658
|
+
'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.',
|
|
2659
2659
|
stainlessPath: '(resource) qbd.credit_memos > (method) delete',
|
|
2660
2660
|
qualified: 'client.qbd.creditMemos.delete',
|
|
2661
2661
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
2662
2662
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_credit_memo'; refNumber: string; }",
|
|
2663
2663
|
markdown:
|
|
2664
|
-
"## 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
|
|
2664
|
+
"## 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```",
|
|
2665
2665
|
perLanguage: {
|
|
2666
2666
|
typescript: {
|
|
2667
2667
|
method: 'client.qbd.creditMemos.delete',
|
|
@@ -3554,13 +3554,13 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
3554
3554
|
httpMethod: 'delete',
|
|
3555
3555
|
summary: 'Delete a deposit',
|
|
3556
3556
|
description:
|
|
3557
|
-
'Permanently deletes a
|
|
3557
|
+
'Permanently deletes a deposit. The deletion will fail if the deposit is currently in use or has any linked transactions that are in use.',
|
|
3558
3558
|
stainlessPath: '(resource) qbd.deposits > (method) delete',
|
|
3559
3559
|
qualified: 'client.qbd.deposits.delete',
|
|
3560
3560
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
3561
3561
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_deposit'; }",
|
|
3562
3562
|
markdown:
|
|
3563
|
-
"## 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
|
|
3563
|
+
"## 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```",
|
|
3564
3564
|
perLanguage: {
|
|
3565
3565
|
typescript: {
|
|
3566
3566
|
method: 'client.qbd.deposits.delete',
|
|
@@ -4173,13 +4173,13 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4173
4173
|
httpMethod: 'delete',
|
|
4174
4174
|
summary: 'Delete an estimate',
|
|
4175
4175
|
description:
|
|
4176
|
-
'Permanently deletes
|
|
4176
|
+
'Permanently deletes an estimate. The deletion will fail if the estimate is currently in use or has any linked transactions that are in use.',
|
|
4177
4177
|
stainlessPath: '(resource) qbd.estimates > (method) delete',
|
|
4178
4178
|
qualified: 'client.qbd.estimates.delete',
|
|
4179
4179
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
4180
4180
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_estimate'; refNumber: string; }",
|
|
4181
4181
|
markdown:
|
|
4182
|
-
"## 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
|
|
4182
|
+
"## 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```",
|
|
4183
4183
|
perLanguage: {
|
|
4184
4184
|
typescript: {
|
|
4185
4185
|
method: 'client.qbd.estimates.delete',
|
|
@@ -4399,13 +4399,13 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
4399
4399
|
httpMethod: 'delete',
|
|
4400
4400
|
summary: 'Delete an inventory adjustment',
|
|
4401
4401
|
description:
|
|
4402
|
-
'Permanently deletes
|
|
4402
|
+
'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.',
|
|
4403
4403
|
stainlessPath: '(resource) qbd.inventory_adjustments > (method) delete',
|
|
4404
4404
|
qualified: 'client.qbd.inventoryAdjustments.delete',
|
|
4405
4405
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
4406
4406
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_inventory_adjustment'; refNumber: string; }",
|
|
4407
4407
|
markdown:
|
|
4408
|
-
"## 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
|
|
4408
|
+
"## 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```",
|
|
4409
4409
|
perLanguage: {
|
|
4410
4410
|
typescript: {
|
|
4411
4411
|
method: 'client.qbd.inventoryAdjustments.delete',
|
|
@@ -5202,13 +5202,13 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
5202
5202
|
httpMethod: 'delete',
|
|
5203
5203
|
summary: 'Delete an invoice',
|
|
5204
5204
|
description:
|
|
5205
|
-
'Permanently deletes
|
|
5205
|
+
'Permanently deletes an invoice. The deletion will fail if the invoice is currently in use or has any linked transactions that are in use.',
|
|
5206
5206
|
stainlessPath: '(resource) qbd.invoices > (method) delete',
|
|
5207
5207
|
qualified: 'client.qbd.invoices.delete',
|
|
5208
5208
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
5209
5209
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_invoice'; refNumber: string; }",
|
|
5210
5210
|
markdown:
|
|
5211
|
-
"## 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
|
|
5211
|
+
"## 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```",
|
|
5212
5212
|
perLanguage: {
|
|
5213
5213
|
typescript: {
|
|
5214
5214
|
method: 'client.qbd.invoices.delete',
|
|
@@ -5595,13 +5595,13 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
5595
5595
|
httpMethod: 'delete',
|
|
5596
5596
|
summary: 'Delete an item receipt',
|
|
5597
5597
|
description:
|
|
5598
|
-
'Permanently deletes
|
|
5598
|
+
'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.',
|
|
5599
5599
|
stainlessPath: '(resource) qbd.item_receipts > (method) delete',
|
|
5600
5600
|
qualified: 'client.qbd.itemReceipts.delete',
|
|
5601
5601
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
5602
5602
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_item_receipt'; refNumber: string; }",
|
|
5603
5603
|
markdown:
|
|
5604
|
-
"## 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
|
|
5604
|
+
"## 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```",
|
|
5605
5605
|
perLanguage: {
|
|
5606
5606
|
typescript: {
|
|
5607
5607
|
method: 'client.qbd.itemReceipts.delete',
|
|
@@ -5892,13 +5892,13 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
5892
5892
|
httpMethod: 'delete',
|
|
5893
5893
|
summary: 'Delete a journal entry',
|
|
5894
5894
|
description:
|
|
5895
|
-
'Permanently deletes a
|
|
5895
|
+
'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.',
|
|
5896
5896
|
stainlessPath: '(resource) qbd.journal_entries > (method) delete',
|
|
5897
5897
|
qualified: 'client.qbd.journalEntries.delete',
|
|
5898
5898
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
5899
5899
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_journal_entry'; refNumber: string; }",
|
|
5900
5900
|
markdown:
|
|
5901
|
-
"## 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
|
|
5901
|
+
"## 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```",
|
|
5902
5902
|
perLanguage: {
|
|
5903
5903
|
typescript: {
|
|
5904
5904
|
method: 'client.qbd.journalEntries.delete',
|
|
@@ -7062,13 +7062,13 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
7062
7062
|
httpMethod: 'delete',
|
|
7063
7063
|
summary: 'Delete a purchase order',
|
|
7064
7064
|
description:
|
|
7065
|
-
'Permanently deletes a
|
|
7065
|
+
'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.',
|
|
7066
7066
|
stainlessPath: '(resource) qbd.purchase_orders > (method) delete',
|
|
7067
7067
|
qualified: 'client.qbd.purchaseOrders.delete',
|
|
7068
7068
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
7069
7069
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_purchase_order'; refNumber: string; }",
|
|
7070
7070
|
markdown:
|
|
7071
|
-
"## 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
|
|
7071
|
+
"## 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```",
|
|
7072
7072
|
perLanguage: {
|
|
7073
7073
|
typescript: {
|
|
7074
7074
|
method: 'client.qbd.purchaseOrders.delete',
|
|
@@ -7265,13 +7265,13 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
7265
7265
|
httpMethod: 'delete',
|
|
7266
7266
|
summary: 'Delete a receive-payment',
|
|
7267
7267
|
description:
|
|
7268
|
-
'Permanently deletes a
|
|
7268
|
+
'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.',
|
|
7269
7269
|
stainlessPath: '(resource) qbd.receive_payments > (method) delete',
|
|
7270
7270
|
qualified: 'client.qbd.receivePayments.delete',
|
|
7271
7271
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
7272
7272
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_receive_payment'; refNumber: string; }",
|
|
7273
7273
|
markdown:
|
|
7274
|
-
"## 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
|
|
7274
|
+
"## 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```",
|
|
7275
7275
|
perLanguage: {
|
|
7276
7276
|
typescript: {
|
|
7277
7277
|
method: 'client.qbd.receivePayments.delete',
|
|
@@ -8060,13 +8060,13 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
8060
8060
|
httpMethod: 'delete',
|
|
8061
8061
|
summary: 'Delete a sales order',
|
|
8062
8062
|
description:
|
|
8063
|
-
'Permanently deletes a
|
|
8063
|
+
'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.',
|
|
8064
8064
|
stainlessPath: '(resource) qbd.sales_orders > (method) delete',
|
|
8065
8065
|
qualified: 'client.qbd.salesOrders.delete',
|
|
8066
8066
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
8067
8067
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_sales_order'; refNumber: string; }",
|
|
8068
8068
|
markdown:
|
|
8069
|
-
"## 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
|
|
8069
|
+
"## 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```",
|
|
8070
8070
|
perLanguage: {
|
|
8071
8071
|
typescript: {
|
|
8072
8072
|
method: 'client.qbd.salesOrders.delete',
|
|
@@ -8324,13 +8324,13 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
8324
8324
|
httpMethod: 'delete',
|
|
8325
8325
|
summary: 'Delete a sales receipt',
|
|
8326
8326
|
description:
|
|
8327
|
-
'Permanently deletes a
|
|
8327
|
+
'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.',
|
|
8328
8328
|
stainlessPath: '(resource) qbd.sales_receipts > (method) delete',
|
|
8329
8329
|
qualified: 'client.qbd.salesReceipts.delete',
|
|
8330
8330
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
8331
8331
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_sales_receipt'; refNumber: string; }",
|
|
8332
8332
|
markdown:
|
|
8333
|
-
"## 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
|
|
8333
|
+
"## 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```",
|
|
8334
8334
|
perLanguage: {
|
|
8335
8335
|
typescript: {
|
|
8336
8336
|
method: 'client.qbd.salesReceipts.delete',
|
|
@@ -8961,6 +8961,230 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
8961
8961
|
},
|
|
8962
8962
|
},
|
|
8963
8963
|
},
|
|
8964
|
+
{
|
|
8965
|
+
name: 'create',
|
|
8966
|
+
endpoint: '/quickbooks-desktop/sales-tax-payment-checks',
|
|
8967
|
+
httpMethod: 'post',
|
|
8968
|
+
summary: 'Create a sales-tax payment check',
|
|
8969
|
+
description: 'Creates a new sales-tax payment check.',
|
|
8970
|
+
stainlessPath: '(resource) qbd.sales_tax_payment_checks > (method) create',
|
|
8971
|
+
qualified: 'client.qbd.salesTaxPaymentChecks.create',
|
|
8972
|
+
params: [
|
|
8973
|
+
'bankAccountId: string;',
|
|
8974
|
+
'lines: { amount: string; salesTaxItemId?: string; }[];',
|
|
8975
|
+
'transactionDate: string;',
|
|
8976
|
+
'vendorId: string;',
|
|
8977
|
+
'Conductor-End-User-Id: string;',
|
|
8978
|
+
'address?: { city?: string; country?: string; line1?: string; line2?: string; line3?: string; line4?: string; line5?: string; note?: string; postalCode?: string; state?: string; };',
|
|
8979
|
+
'externalId?: string;',
|
|
8980
|
+
'isQueuedForPrint?: boolean;',
|
|
8981
|
+
'memo?: string;',
|
|
8982
|
+
'refNumber?: string;',
|
|
8983
|
+
],
|
|
8984
|
+
response:
|
|
8985
|
+
"{ 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; }; }",
|
|
8986
|
+
markdown:
|
|
8987
|
+
"## 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```",
|
|
8988
|
+
perLanguage: {
|
|
8989
|
+
typescript: {
|
|
8990
|
+
method: 'client.qbd.salesTaxPaymentChecks.create',
|
|
8991
|
+
example:
|
|
8992
|
+
"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);",
|
|
8993
|
+
},
|
|
8994
|
+
python: {
|
|
8995
|
+
method: 'qbd.sales_tax_payment_checks.create',
|
|
8996
|
+
example:
|
|
8997
|
+
'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)',
|
|
8998
|
+
},
|
|
8999
|
+
http: {
|
|
9000
|
+
example:
|
|
9001
|
+
'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 }\'',
|
|
9002
|
+
},
|
|
9003
|
+
},
|
|
9004
|
+
},
|
|
9005
|
+
{
|
|
9006
|
+
name: 'list',
|
|
9007
|
+
endpoint: '/quickbooks-desktop/sales-tax-payment-checks',
|
|
9008
|
+
httpMethod: 'get',
|
|
9009
|
+
summary: 'List all sales-tax payment checks',
|
|
9010
|
+
description:
|
|
9011
|
+
'Returns a list of sales-tax payment checks. Use the `cursor` parameter to paginate through the results.',
|
|
9012
|
+
stainlessPath: '(resource) qbd.sales_tax_payment_checks > (method) list',
|
|
9013
|
+
qualified: 'client.qbd.salesTaxPaymentChecks.list',
|
|
9014
|
+
params: [
|
|
9015
|
+
'Conductor-End-User-Id: string;',
|
|
9016
|
+
'accountIds?: string[];',
|
|
9017
|
+
'cursor?: string;',
|
|
9018
|
+
'ids?: string[];',
|
|
9019
|
+
'includeLineItems?: boolean;',
|
|
9020
|
+
'itemIds?: string[];',
|
|
9021
|
+
'limit?: number;',
|
|
9022
|
+
'refNumberContains?: string;',
|
|
9023
|
+
'refNumberEndsWith?: string;',
|
|
9024
|
+
'refNumberFrom?: string;',
|
|
9025
|
+
'refNumbers?: string[];',
|
|
9026
|
+
'refNumberStartsWith?: string;',
|
|
9027
|
+
'refNumberTo?: string;',
|
|
9028
|
+
'transactionDateFrom?: string;',
|
|
9029
|
+
'transactionDateTo?: string;',
|
|
9030
|
+
'updatedAfter?: string;',
|
|
9031
|
+
'updatedBefore?: string;',
|
|
9032
|
+
'vendorIds?: string[];',
|
|
9033
|
+
],
|
|
9034
|
+
response:
|
|
9035
|
+
"{ 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; }; }",
|
|
9036
|
+
markdown:
|
|
9037
|
+
"## 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```",
|
|
9038
|
+
perLanguage: {
|
|
9039
|
+
typescript: {
|
|
9040
|
+
method: 'client.qbd.salesTaxPaymentChecks.list',
|
|
9041
|
+
example:
|
|
9042
|
+
"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}",
|
|
9043
|
+
},
|
|
9044
|
+
python: {
|
|
9045
|
+
method: 'qbd.sales_tax_payment_checks.list',
|
|
9046
|
+
example:
|
|
9047
|
+
'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)',
|
|
9048
|
+
},
|
|
9049
|
+
http: {
|
|
9050
|
+
example:
|
|
9051
|
+
'curl https://api.conductor.is/v1/quickbooks-desktop/sales-tax-payment-checks \\\n -H "Authorization: Bearer $CONDUCTOR_SECRET_KEY"',
|
|
9052
|
+
},
|
|
9053
|
+
},
|
|
9054
|
+
},
|
|
9055
|
+
{
|
|
9056
|
+
name: 'retrieve',
|
|
9057
|
+
endpoint: '/quickbooks-desktop/sales-tax-payment-checks/{id}',
|
|
9058
|
+
httpMethod: 'get',
|
|
9059
|
+
summary: 'Retrieve a sales-tax payment check',
|
|
9060
|
+
description:
|
|
9061
|
+
'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.',
|
|
9062
|
+
stainlessPath: '(resource) qbd.sales_tax_payment_checks > (method) retrieve',
|
|
9063
|
+
qualified: 'client.qbd.salesTaxPaymentChecks.retrieve',
|
|
9064
|
+
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
9065
|
+
response:
|
|
9066
|
+
"{ 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; }; }",
|
|
9067
|
+
markdown:
|
|
9068
|
+
"## 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```",
|
|
9069
|
+
perLanguage: {
|
|
9070
|
+
typescript: {
|
|
9071
|
+
method: 'client.qbd.salesTaxPaymentChecks.retrieve',
|
|
9072
|
+
example:
|
|
9073
|
+
"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);",
|
|
9074
|
+
},
|
|
9075
|
+
python: {
|
|
9076
|
+
method: 'qbd.sales_tax_payment_checks.retrieve',
|
|
9077
|
+
example:
|
|
9078
|
+
'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)',
|
|
9079
|
+
},
|
|
9080
|
+
http: {
|
|
9081
|
+
example:
|
|
9082
|
+
'curl https://api.conductor.is/v1/quickbooks-desktop/sales-tax-payment-checks/$ID \\\n -H "Authorization: Bearer $CONDUCTOR_SECRET_KEY"',
|
|
9083
|
+
},
|
|
9084
|
+
},
|
|
9085
|
+
},
|
|
9086
|
+
{
|
|
9087
|
+
name: 'update',
|
|
9088
|
+
endpoint: '/quickbooks-desktop/sales-tax-payment-checks/{id}',
|
|
9089
|
+
httpMethod: 'post',
|
|
9090
|
+
summary: 'Update a sales-tax payment check',
|
|
9091
|
+
description: 'Updates an existing sales-tax payment check.',
|
|
9092
|
+
stainlessPath: '(resource) qbd.sales_tax_payment_checks > (method) update',
|
|
9093
|
+
qualified: 'client.qbd.salesTaxPaymentChecks.update',
|
|
9094
|
+
params: [
|
|
9095
|
+
'id: string;',
|
|
9096
|
+
'revisionNumber: string;',
|
|
9097
|
+
'Conductor-End-User-Id: string;',
|
|
9098
|
+
'address?: { city?: string; country?: string; line1?: string; line2?: string; line3?: string; line4?: string; line5?: string; note?: string; postalCode?: string; state?: string; };',
|
|
9099
|
+
'bankAccountId?: string;',
|
|
9100
|
+
'isQueuedForPrint?: boolean;',
|
|
9101
|
+
'memo?: string;',
|
|
9102
|
+
'refNumber?: string;',
|
|
9103
|
+
'transactionDate?: string;',
|
|
9104
|
+
],
|
|
9105
|
+
response:
|
|
9106
|
+
"{ 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; }; }",
|
|
9107
|
+
markdown:
|
|
9108
|
+
"## 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```",
|
|
9109
|
+
perLanguage: {
|
|
9110
|
+
typescript: {
|
|
9111
|
+
method: 'client.qbd.salesTaxPaymentChecks.update',
|
|
9112
|
+
example:
|
|
9113
|
+
"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);",
|
|
9114
|
+
},
|
|
9115
|
+
python: {
|
|
9116
|
+
method: 'qbd.sales_tax_payment_checks.update',
|
|
9117
|
+
example:
|
|
9118
|
+
'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)',
|
|
9119
|
+
},
|
|
9120
|
+
http: {
|
|
9121
|
+
example:
|
|
9122
|
+
'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 }\'',
|
|
9123
|
+
},
|
|
9124
|
+
},
|
|
9125
|
+
},
|
|
9126
|
+
{
|
|
9127
|
+
name: 'void',
|
|
9128
|
+
endpoint: '/quickbooks-desktop/sales-tax-payment-checks/{id}/void',
|
|
9129
|
+
httpMethod: 'post',
|
|
9130
|
+
summary: 'Void a sales-tax payment check',
|
|
9131
|
+
description:
|
|
9132
|
+
'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.',
|
|
9133
|
+
stainlessPath: '(resource) qbd.sales_tax_payment_checks > (method) void',
|
|
9134
|
+
qualified: 'client.qbd.salesTaxPaymentChecks.void',
|
|
9135
|
+
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
9136
|
+
response:
|
|
9137
|
+
"{ id: string; createdAt: string; objectType: 'qbd_sales_tax_payment_check'; refNumber: string; updatedAt: string; voided: boolean; }",
|
|
9138
|
+
markdown:
|
|
9139
|
+
"## 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```",
|
|
9140
|
+
perLanguage: {
|
|
9141
|
+
typescript: {
|
|
9142
|
+
method: 'client.qbd.salesTaxPaymentChecks.void',
|
|
9143
|
+
example:
|
|
9144
|
+
"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);",
|
|
9145
|
+
},
|
|
9146
|
+
python: {
|
|
9147
|
+
method: 'qbd.sales_tax_payment_checks.void',
|
|
9148
|
+
example:
|
|
9149
|
+
'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)',
|
|
9150
|
+
},
|
|
9151
|
+
http: {
|
|
9152
|
+
example:
|
|
9153
|
+
'curl https://api.conductor.is/v1/quickbooks-desktop/sales-tax-payment-checks/$ID/void \\\n -X POST \\\n -H "Authorization: Bearer $CONDUCTOR_SECRET_KEY"',
|
|
9154
|
+
},
|
|
9155
|
+
},
|
|
9156
|
+
},
|
|
9157
|
+
{
|
|
9158
|
+
name: 'delete',
|
|
9159
|
+
endpoint: '/quickbooks-desktop/sales-tax-payment-checks/{id}',
|
|
9160
|
+
httpMethod: 'delete',
|
|
9161
|
+
summary: 'Delete a sales-tax payment check',
|
|
9162
|
+
description:
|
|
9163
|
+
'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.',
|
|
9164
|
+
stainlessPath: '(resource) qbd.sales_tax_payment_checks > (method) delete',
|
|
9165
|
+
qualified: 'client.qbd.salesTaxPaymentChecks.delete',
|
|
9166
|
+
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
9167
|
+
response:
|
|
9168
|
+
"{ id: string; deleted: boolean; objectType: 'qbd_sales_tax_payment_check'; refNumber: string; }",
|
|
9169
|
+
markdown:
|
|
9170
|
+
"## 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```",
|
|
9171
|
+
perLanguage: {
|
|
9172
|
+
typescript: {
|
|
9173
|
+
method: 'client.qbd.salesTaxPaymentChecks.delete',
|
|
9174
|
+
example:
|
|
9175
|
+
"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);",
|
|
9176
|
+
},
|
|
9177
|
+
python: {
|
|
9178
|
+
method: 'qbd.sales_tax_payment_checks.delete',
|
|
9179
|
+
example:
|
|
9180
|
+
'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)',
|
|
9181
|
+
},
|
|
9182
|
+
http: {
|
|
9183
|
+
example:
|
|
9184
|
+
'curl https://api.conductor.is/v1/quickbooks-desktop/sales-tax-payment-checks/$ID \\\n -X DELETE \\\n -H "Authorization: Bearer $CONDUCTOR_SECRET_KEY"',
|
|
9185
|
+
},
|
|
9186
|
+
},
|
|
9187
|
+
},
|
|
8964
9188
|
{
|
|
8965
9189
|
name: 'create',
|
|
8966
9190
|
endpoint: '/quickbooks-desktop/service-items',
|
|
@@ -9686,13 +9910,13 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
9686
9910
|
httpMethod: 'delete',
|
|
9687
9911
|
summary: 'Delete a time tracking activity',
|
|
9688
9912
|
description:
|
|
9689
|
-
'Permanently deletes a
|
|
9913
|
+
'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.',
|
|
9690
9914
|
stainlessPath: '(resource) qbd.time_tracking_activities > (method) delete',
|
|
9691
9915
|
qualified: 'client.qbd.timeTrackingActivities.delete',
|
|
9692
9916
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
9693
9917
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_time_tracking_activity'; }",
|
|
9694
9918
|
markdown:
|
|
9695
|
-
"## 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
|
|
9919
|
+
"## 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```",
|
|
9696
9920
|
perLanguage: {
|
|
9697
9921
|
typescript: {
|
|
9698
9922
|
method: 'client.qbd.timeTrackingActivities.delete',
|
|
@@ -10268,13 +10492,13 @@ const EMBEDDED_METHODS: MethodEntry[] = [
|
|
|
10268
10492
|
httpMethod: 'delete',
|
|
10269
10493
|
summary: 'Delete a vendor credit',
|
|
10270
10494
|
description:
|
|
10271
|
-
'Permanently deletes a
|
|
10495
|
+
'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.',
|
|
10272
10496
|
stainlessPath: '(resource) qbd.vendor_credits > (method) delete',
|
|
10273
10497
|
qualified: 'client.qbd.vendorCredits.delete',
|
|
10274
10498
|
params: ['id: string;', 'Conductor-End-User-Id: string;'],
|
|
10275
10499
|
response: "{ id: string; deleted: boolean; objectType: 'qbd_vendor_credit'; refNumber: string; }",
|
|
10276
10500
|
markdown:
|
|
10277
|
-
"## 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
|
|
10501
|
+
"## 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```",
|
|
10278
10502
|
perLanguage: {
|
|
10279
10503
|
typescript: {
|
|
10280
10504
|
method: 'client.qbd.vendorCredits.delete',
|