conductor-node 11.4.0 → 11.4.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
<!-- markdownlint-disable MD033 MD041 -->
|
|
2
2
|
<div align="center">
|
|
3
3
|
<h1><a href="https://conductor.is">Conductor</a></h1>
|
|
4
|
-
<h3>QuickBooks Desktop API for Node.js and
|
|
4
|
+
<h3>QuickBooks Desktop API for Node.js, TypeScript, and REST</h3>
|
|
5
5
|
<a href="https://npmjs.com/package/conductor-node"><img src="https://img.shields.io/npm/dm/conductor-node.svg?logo=npm" alt="NPM download count"></a>
|
|
6
6
|
<a href="https://npmjs.org/package/conductor-node"><img src="https://img.shields.io/npm/v/conductor-node.svg?logo=npm" alt="Package version"></a>
|
|
7
7
|
<img src="https://img.shields.io/badge/coverage-100%25-brightgreen" alt="Code coverage">
|
|
@@ -24,6 +24,8 @@
|
|
|
24
24
|
|
|
25
25
|
Conductor is a TypeScript-first Node.js API for **QuickBooks Desktop** (also known as QuickBooks Enterprise). In just a few lines, get real-time access to fetch, create, or update [_any_ QuickBooks Desktop object type](https://docs.conductor.is/qbd/api#supported-object-types) and receive a fully-typed response. Check out [the documentation](https://docs.conductor.is) to get started.
|
|
26
26
|
|
|
27
|
+
We also offer a [REST API](https://docs.conductor.is/usage/rest).
|
|
28
|
+
|
|
27
29
|
Conductor, the company, is building a data integration platform for vertical SaaS companies, starting with QuickBooks Desktop. Our team has spent over a decade building companies, scaling vast software systems, and obsessing over quality.
|
|
28
30
|
|
|
29
31
|
<!-- markdownlint-disable MD033 -->
|
|
@@ -41,7 +43,7 @@ Conductor, the company, is building a data integration platform for vertical Saa
|
|
|
41
43
|
|
|
42
44
|
## Requirements
|
|
43
45
|
|
|
44
|
-
1. A Conductor API key pair: one secret key, one publishable key. Please [complete this form](https://
|
|
46
|
+
1. A Conductor API key pair: one secret key, one publishable key. Please [complete this form](https://forms.gle/1LTGXy2Hcyzw6qWa6) to join the beta.
|
|
45
47
|
2. Node.js v16 or later.
|
|
46
48
|
|
|
47
49
|
## Installation
|
package/dist/package.json
CHANGED
|
@@ -993,7 +993,7 @@ export default class QbdIntegration extends BaseIntegration {
|
|
|
993
993
|
* If you Add an invoice that has an inventory item on it, QB will
|
|
994
994
|
* automatically calculate COGS and post it to the COGS account. (The
|
|
995
995
|
* inventory item will need to be setup to post to the COGS account and must
|
|
996
|
-
* have a unit cost in it.) However, notice that such an InvoiceAdd has
|
|
996
|
+
* have a unit cost in it.) However, notice that such an `InvoiceAdd` has
|
|
997
997
|
* sales prices, not cost, so the Add is not impacting the cost of the item.
|
|
998
998
|
* The cost of the item is only affected by purchases (bills and item
|
|
999
999
|
* receipts) sales and inventory adjustments.
|
|
@@ -2456,14 +2456,23 @@ export default class QbdIntegration extends BaseIntegration {
|
|
|
2456
2456
|
*/
|
|
2457
2457
|
timeTracking: {
|
|
2458
2458
|
/**
|
|
2459
|
-
*
|
|
2460
|
-
* time
|
|
2461
|
-
*
|
|
2462
|
-
*
|
|
2463
|
-
*
|
|
2464
|
-
*
|
|
2465
|
-
*
|
|
2466
|
-
*
|
|
2459
|
+
* This request adds a time tracking transaction to QuickBooks, mirroring
|
|
2460
|
+
* the time-tracking feature available in the QuickBooks UI. The time
|
|
2461
|
+
* tracking feature allows a QuickBooks user to base payroll or invoices on
|
|
2462
|
+
* time worked. You can add time-tracking information to any vendor,
|
|
2463
|
+
* employee, or person on the Other Names list in QuickBooks.
|
|
2464
|
+
*
|
|
2465
|
+
* If `IsBillable` is set to true, both `CustomerRef` and `ItemServiceRef`
|
|
2466
|
+
* are required. There is no link between an invoice and the time entries.
|
|
2467
|
+
* However, when you do the invoicing from QuickBooks, QuickBooks does mark
|
|
2468
|
+
* the time entries as “billed.” If you don’t record the time entries as
|
|
2469
|
+
* billed properly, then you get into a user workflow issue where every time
|
|
2470
|
+
* the user creates an invoice for a customer, QB pops up a dialog asking if
|
|
2471
|
+
* they want to bill the un-billed time (which you already billed from your
|
|
2472
|
+
* app).
|
|
2473
|
+
*
|
|
2474
|
+
* See more:
|
|
2475
|
+
* https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TimeTrackingAdd
|
|
2467
2476
|
*/
|
|
2468
2477
|
add: (endUserId: string, params: QbdTypes.TimeTrackingAddRq["TimeTrackingAdd"]) => Promise<NonNullable<QbdTypes.TimeTrackingAddRs["TimeTrackingRet"]>>;
|
|
2469
2478
|
/**
|
|
@@ -998,7 +998,7 @@ class QbdIntegration extends BaseIntegration_1.default {
|
|
|
998
998
|
* If you Add an invoice that has an inventory item on it, QB will
|
|
999
999
|
* automatically calculate COGS and post it to the COGS account. (The
|
|
1000
1000
|
* inventory item will need to be setup to post to the COGS account and must
|
|
1001
|
-
* have a unit cost in it.) However, notice that such an InvoiceAdd has
|
|
1001
|
+
* have a unit cost in it.) However, notice that such an `InvoiceAdd` has
|
|
1002
1002
|
* sales prices, not cost, so the Add is not impacting the cost of the item.
|
|
1003
1003
|
* The cost of the item is only affected by purchases (bills and item
|
|
1004
1004
|
* receipts) sales and inventory adjustments.
|
|
@@ -2461,14 +2461,23 @@ class QbdIntegration extends BaseIntegration_1.default {
|
|
|
2461
2461
|
*/
|
|
2462
2462
|
timeTracking = {
|
|
2463
2463
|
/**
|
|
2464
|
-
*
|
|
2465
|
-
* time
|
|
2466
|
-
*
|
|
2467
|
-
*
|
|
2468
|
-
*
|
|
2469
|
-
*
|
|
2470
|
-
*
|
|
2471
|
-
*
|
|
2464
|
+
* This request adds a time tracking transaction to QuickBooks, mirroring
|
|
2465
|
+
* the time-tracking feature available in the QuickBooks UI. The time
|
|
2466
|
+
* tracking feature allows a QuickBooks user to base payroll or invoices on
|
|
2467
|
+
* time worked. You can add time-tracking information to any vendor,
|
|
2468
|
+
* employee, or person on the Other Names list in QuickBooks.
|
|
2469
|
+
*
|
|
2470
|
+
* If `IsBillable` is set to true, both `CustomerRef` and `ItemServiceRef`
|
|
2471
|
+
* are required. There is no link between an invoice and the time entries.
|
|
2472
|
+
* However, when you do the invoicing from QuickBooks, QuickBooks does mark
|
|
2473
|
+
* the time entries as “billed.” If you don’t record the time entries as
|
|
2474
|
+
* billed properly, then you get into a user workflow issue where every time
|
|
2475
|
+
* the user creates an invoice for a customer, QB pops up a dialog asking if
|
|
2476
|
+
* they want to bill the un-billed time (which you already billed from your
|
|
2477
|
+
* app).
|
|
2478
|
+
*
|
|
2479
|
+
* See more:
|
|
2480
|
+
* https://developer.intuit.com/app/developer/qbdesktop/docs/api-reference/qbdesktop/TimeTrackingAdd
|
|
2472
2481
|
*/
|
|
2473
2482
|
add: async (endUserId, params) => this.sendRequestWrapper(endUserId, { TimeTrackingAddRq: { TimeTrackingAdd: params } }, "TimeTrackingAddRs", "TimeTrackingRet"),
|
|
2474
2483
|
/**
|
|
@@ -29,7 +29,11 @@ export interface AuthSession {
|
|
|
29
29
|
* after they complete the authentication flow. If `null`, their browser tab
|
|
30
30
|
* will close instead.
|
|
31
31
|
*/
|
|
32
|
-
readonly
|
|
32
|
+
readonly redirectUrl: string | undefined;
|
|
33
|
+
/**
|
|
34
|
+
* @deprecated Use `redirectUrl` instead.
|
|
35
|
+
*/
|
|
36
|
+
readonly returnUrl?: string | undefined;
|
|
33
37
|
}
|
|
34
38
|
export interface AuthSessionCreateInput {
|
|
35
39
|
/**
|
|
@@ -52,6 +56,10 @@ export interface AuthSessionCreateInput {
|
|
|
52
56
|
* after they complete the authentication flow. If not provided, their browser
|
|
53
57
|
* tab will close instead.
|
|
54
58
|
*/
|
|
59
|
+
readonly redirectUrl?: string;
|
|
60
|
+
/**
|
|
61
|
+
* @deprecated Use `redirectUrl` instead.
|
|
62
|
+
*/
|
|
55
63
|
readonly returnUrl?: string;
|
|
56
64
|
}
|
|
57
65
|
export default class AuthSessionsResource extends BaseResource {
|