conductor-node 12.43.0 → 13.1.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/CHANGELOG.md +29 -0
- package/README.md +111 -41
- package/api-promise.d.mts +2 -0
- package/api-promise.d.mts.map +1 -0
- package/api-promise.d.ts +2 -0
- package/api-promise.d.ts.map +1 -0
- package/api-promise.js +6 -0
- package/api-promise.js.map +1 -0
- package/api-promise.mjs +2 -0
- package/api-promise.mjs.map +1 -0
- package/bin/cli +46 -0
- package/bin/migration-config.json +44 -0
- package/client.d.mts +189 -0
- package/client.d.mts.map +1 -0
- package/client.d.ts +189 -0
- package/client.d.ts.map +1 -0
- package/client.js +462 -0
- package/client.js.map +1 -0
- package/client.mjs +458 -0
- package/client.mjs.map +1 -0
- package/core/api-promise.d.mts +46 -0
- package/core/api-promise.d.mts.map +1 -0
- package/core/api-promise.d.ts +46 -0
- package/core/api-promise.d.ts.map +1 -0
- package/core/api-promise.js +74 -0
- package/core/api-promise.js.map +1 -0
- package/core/api-promise.mjs +70 -0
- package/core/api-promise.mjs.map +1 -0
- package/core/error.d.mts +46 -0
- package/core/error.d.mts.map +1 -0
- package/core/error.d.ts +46 -0
- package/core/error.d.ts.map +1 -0
- package/core/error.js +113 -0
- package/core/error.js.map +1 -0
- package/core/error.mjs +97 -0
- package/core/error.mjs.map +1 -0
- package/core/pagination.d.mts +54 -0
- package/core/pagination.d.mts.map +1 -0
- package/core/pagination.d.ts +54 -0
- package/core/pagination.d.ts.map +1 -0
- package/core/pagination.js +101 -0
- package/core/pagination.js.map +1 -0
- package/core/pagination.mjs +95 -0
- package/core/pagination.mjs.map +1 -0
- package/core/resource.d.mts +6 -0
- package/core/resource.d.mts.map +1 -0
- package/core/resource.d.ts +6 -0
- package/core/resource.d.ts.map +1 -0
- package/core/resource.js +11 -0
- package/core/resource.js.map +1 -0
- package/core/resource.mjs +7 -0
- package/core/resource.mjs.map +1 -0
- package/core/uploads.d.mts +3 -0
- package/core/uploads.d.mts.map +1 -0
- package/core/uploads.d.ts +3 -0
- package/core/uploads.d.ts.map +1 -0
- package/core/uploads.js +6 -0
- package/core/uploads.js.map +1 -0
- package/core/uploads.mjs +2 -0
- package/core/uploads.mjs.map +1 -0
- package/error.d.mts +2 -0
- package/error.d.mts.map +1 -0
- package/error.d.ts +1 -46
- package/error.d.ts.map +1 -1
- package/error.js +3 -110
- package/error.js.map +1 -1
- package/error.mjs +1 -96
- package/error.mjs.map +1 -1
- package/index.d.mts +7 -124
- package/index.d.mts.map +1 -0
- package/index.d.ts +6 -123
- package/index.d.ts.map +1 -1
- package/index.js +14 -119
- package/index.js.map +1 -1
- package/index.mjs +6 -92
- package/index.mjs.map +1 -1
- package/internal/builtin-types.d.mts +73 -0
- package/internal/builtin-types.d.mts.map +1 -0
- package/internal/builtin-types.d.ts +73 -0
- package/internal/builtin-types.d.ts.map +1 -0
- package/internal/builtin-types.js +4 -0
- package/internal/builtin-types.js.map +1 -0
- package/internal/builtin-types.mjs +3 -0
- package/internal/builtin-types.mjs.map +1 -0
- package/internal/detect-platform.d.mts +15 -0
- package/internal/detect-platform.d.mts.map +1 -0
- package/internal/detect-platform.d.ts +15 -0
- package/internal/detect-platform.d.ts.map +1 -0
- package/internal/detect-platform.js +162 -0
- package/internal/detect-platform.js.map +1 -0
- package/internal/detect-platform.mjs +157 -0
- package/internal/detect-platform.mjs.map +1 -0
- package/internal/errors.d.mts +3 -0
- package/internal/errors.d.mts.map +1 -0
- package/internal/errors.d.ts +3 -0
- package/internal/errors.d.ts.map +1 -0
- package/internal/errors.js +41 -0
- package/internal/errors.js.map +1 -0
- package/internal/errors.mjs +36 -0
- package/internal/errors.mjs.map +1 -0
- package/internal/headers.d.mts +20 -0
- package/internal/headers.d.mts.map +1 -0
- package/internal/headers.d.ts +20 -0
- package/internal/headers.d.ts.map +1 -0
- package/internal/headers.js +79 -0
- package/internal/headers.js.map +1 -0
- package/internal/headers.mjs +74 -0
- package/internal/headers.mjs.map +1 -0
- package/internal/parse.d.mts +12 -0
- package/internal/parse.d.mts.map +1 -0
- package/internal/parse.d.ts +12 -0
- package/internal/parse.d.ts.map +1 -0
- package/internal/parse.js +35 -0
- package/internal/parse.js.map +1 -0
- package/internal/parse.mjs +32 -0
- package/internal/parse.mjs.map +1 -0
- package/internal/qs/formats.d.mts +7 -0
- package/internal/qs/formats.d.mts.map +1 -0
- package/internal/qs/formats.d.ts +1 -0
- package/internal/qs/formats.d.ts.map +1 -1
- package/internal/qs/formats.js +4 -2
- package/internal/qs/formats.js.map +1 -1
- package/internal/qs/formats.mjs +2 -1
- package/internal/qs/formats.mjs.map +1 -1
- package/internal/qs/index.d.mts +10 -0
- package/internal/qs/index.d.mts.map +1 -0
- package/internal/qs/index.d.ts.map +1 -1
- package/internal/qs/stringify.d.mts +3 -0
- package/internal/qs/stringify.d.mts.map +1 -0
- package/internal/qs/stringify.d.ts.map +1 -1
- package/internal/qs/stringify.js +16 -19
- package/internal/qs/stringify.js.map +1 -1
- package/internal/qs/stringify.mjs +17 -19
- package/internal/qs/stringify.mjs.map +1 -1
- package/internal/qs/types.d.mts +57 -0
- package/internal/qs/types.d.mts.map +1 -0
- package/internal/qs/utils.d.mts +15 -0
- package/internal/qs/utils.d.mts.map +1 -0
- package/internal/qs/utils.d.ts +1 -0
- package/internal/qs/utils.d.ts.map +1 -1
- package/internal/qs/utils.js +22 -21
- package/internal/qs/utils.js.map +1 -1
- package/internal/qs/utils.mjs +12 -12
- package/internal/qs/utils.mjs.map +1 -1
- package/internal/request-options.d.mts +75 -0
- package/internal/request-options.d.mts.map +1 -0
- package/internal/request-options.d.ts +75 -0
- package/internal/request-options.d.ts.map +1 -0
- package/internal/request-options.js +14 -0
- package/internal/request-options.js.map +1 -0
- package/internal/request-options.mjs +10 -0
- package/internal/request-options.mjs.map +1 -0
- package/internal/shim-types.d.mts +17 -0
- package/internal/shim-types.d.mts.map +1 -0
- package/internal/shim-types.d.ts +17 -0
- package/internal/shim-types.d.ts.map +1 -0
- package/internal/shim-types.js +4 -0
- package/internal/shim-types.js.map +1 -0
- package/internal/shim-types.mjs +3 -0
- package/internal/shim-types.mjs.map +1 -0
- package/internal/shims.d.mts +20 -0
- package/internal/shims.d.mts.map +1 -0
- package/internal/shims.d.ts +20 -0
- package/internal/shims.d.ts.map +1 -0
- package/internal/shims.js +92 -0
- package/internal/shims.js.map +1 -0
- package/internal/shims.mjs +85 -0
- package/internal/shims.mjs.map +1 -0
- package/internal/to-file.d.mts +45 -0
- package/internal/to-file.d.mts.map +1 -0
- package/internal/to-file.d.ts +45 -0
- package/internal/to-file.d.ts.map +1 -0
- package/internal/to-file.js +91 -0
- package/internal/to-file.js.map +1 -0
- package/internal/to-file.mjs +88 -0
- package/internal/to-file.mjs.map +1 -0
- package/internal/tslib.js +81 -0
- package/internal/tslib.mjs +17 -0
- package/internal/types.d.mts +69 -0
- package/internal/types.d.mts.map +1 -0
- package/internal/types.d.ts +69 -0
- package/internal/types.d.ts.map +1 -0
- package/internal/types.js +4 -0
- package/internal/types.js.map +1 -0
- package/internal/types.mjs +3 -0
- package/internal/types.mjs.map +1 -0
- package/internal/uploads.d.mts +42 -0
- package/internal/uploads.d.mts.map +1 -0
- package/internal/uploads.d.ts +42 -0
- package/internal/uploads.d.ts.map +1 -0
- package/internal/uploads.js +141 -0
- package/internal/uploads.js.map +1 -0
- package/internal/uploads.mjs +131 -0
- package/internal/uploads.mjs.map +1 -0
- package/internal/utils/base64.d.mts +3 -0
- package/internal/utils/base64.d.mts.map +1 -0
- package/internal/utils/base64.d.ts +3 -0
- package/internal/utils/base64.d.ts.map +1 -0
- package/internal/utils/base64.js +38 -0
- package/internal/utils/base64.js.map +1 -0
- package/internal/utils/base64.mjs +33 -0
- package/internal/utils/base64.mjs.map +1 -0
- package/internal/utils/bytes.d.mts +4 -0
- package/internal/utils/bytes.d.mts.map +1 -0
- package/internal/utils/bytes.d.ts +4 -0
- package/internal/utils/bytes.d.ts.map +1 -0
- package/internal/utils/bytes.js +31 -0
- package/internal/utils/bytes.js.map +1 -0
- package/internal/utils/bytes.mjs +26 -0
- package/internal/utils/bytes.mjs.map +1 -0
- package/internal/utils/env.d.mts +9 -0
- package/internal/utils/env.d.mts.map +1 -0
- package/internal/utils/env.d.ts +9 -0
- package/internal/utils/env.d.ts.map +1 -0
- package/internal/utils/env.js +22 -0
- package/internal/utils/env.js.map +1 -0
- package/internal/utils/env.mjs +18 -0
- package/internal/utils/env.mjs.map +1 -0
- package/internal/utils/log.d.mts +37 -0
- package/internal/utils/log.d.mts.map +1 -0
- package/internal/utils/log.d.ts +37 -0
- package/internal/utils/log.d.ts.map +1 -0
- package/internal/utils/log.js +85 -0
- package/internal/utils/log.js.map +1 -0
- package/internal/utils/log.mjs +79 -0
- package/internal/utils/log.mjs.map +1 -0
- package/internal/utils/path.d.mts +15 -0
- package/internal/utils/path.d.mts.map +1 -0
- package/internal/utils/path.d.ts +15 -0
- package/internal/utils/path.d.ts.map +1 -0
- package/internal/utils/path.js +79 -0
- package/internal/utils/path.js.map +1 -0
- package/internal/utils/path.mjs +74 -0
- package/internal/utils/path.mjs.map +1 -0
- package/internal/utils/sleep.d.mts +2 -0
- package/internal/utils/sleep.d.mts.map +1 -0
- package/internal/utils/sleep.d.ts +2 -0
- package/internal/utils/sleep.d.ts.map +1 -0
- package/internal/utils/sleep.js +7 -0
- package/internal/utils/sleep.js.map +1 -0
- package/internal/utils/sleep.mjs +3 -0
- package/internal/utils/sleep.mjs.map +1 -0
- package/internal/utils/uuid.d.mts +5 -0
- package/internal/utils/uuid.d.mts.map +1 -0
- package/internal/utils/uuid.d.ts +5 -0
- package/internal/utils/uuid.d.ts.map +1 -0
- package/internal/utils/uuid.js +19 -0
- package/internal/utils/uuid.js.map +1 -0
- package/internal/utils/uuid.mjs +15 -0
- package/internal/utils/uuid.mjs.map +1 -0
- package/internal/utils/values.d.mts +18 -0
- package/internal/utils/values.d.mts.map +1 -0
- package/internal/utils/values.d.ts +18 -0
- package/internal/utils/values.d.ts.map +1 -0
- package/internal/utils/values.js +112 -0
- package/internal/utils/values.js.map +1 -0
- package/internal/utils/values.mjs +94 -0
- package/internal/utils/values.mjs.map +1 -0
- package/internal/utils.d.mts +7 -0
- package/internal/utils.d.mts.map +1 -0
- package/internal/utils.d.ts +7 -0
- package/internal/utils.d.ts.map +1 -0
- package/internal/utils.js +11 -0
- package/internal/utils.js.map +1 -0
- package/internal/utils.mjs +8 -0
- package/internal/utils.mjs.map +1 -0
- package/package.json +113 -64
- package/pagination.d.mts +2 -0
- package/pagination.d.mts.map +1 -0
- package/pagination.d.ts +1 -17
- package/pagination.d.ts.map +1 -1
- package/pagination.js +3 -37
- package/pagination.js.map +1 -1
- package/pagination.mjs +1 -35
- package/pagination.mjs.map +1 -1
- package/resource.d.mts +2 -0
- package/resource.d.mts.map +1 -0
- package/resource.d.ts +1 -5
- package/resource.d.ts.map +1 -1
- package/resource.js +3 -8
- package/resource.js.map +1 -1
- package/resource.mjs +1 -6
- package/resource.mjs.map +1 -1
- package/resources/auth-sessions.d.mts +84 -0
- package/resources/auth-sessions.d.mts.map +1 -0
- package/resources/auth-sessions.d.ts +4 -3
- package/resources/auth-sessions.d.ts.map +1 -1
- package/resources/auth-sessions.js +1 -1
- package/resources/auth-sessions.js.map +1 -1
- package/resources/auth-sessions.mjs +1 -1
- package/resources/auth-sessions.mjs.map +1 -1
- package/resources/end-users.d.mts +195 -0
- package/resources/end-users.d.mts.map +1 -0
- package/resources/end-users.d.ts +24 -12
- package/resources/end-users.d.ts.map +1 -1
- package/resources/end-users.js +14 -7
- package/resources/end-users.js.map +1 -1
- package/resources/end-users.mjs +14 -7
- package/resources/end-users.mjs.map +1 -1
- package/resources/index.d.mts +4 -0
- package/resources/index.d.mts.map +1 -0
- package/resources/index.d.ts.map +1 -1
- package/resources/qbd/account-tax-lines.d.mts +56 -0
- package/resources/qbd/account-tax-lines.d.mts.map +1 -0
- package/resources/qbd/account-tax-lines.d.ts +5 -5
- package/resources/qbd/account-tax-lines.d.ts.map +1 -1
- package/resources/qbd/account-tax-lines.js +3 -2
- package/resources/qbd/account-tax-lines.js.map +1 -1
- package/resources/qbd/account-tax-lines.mjs +3 -2
- package/resources/qbd/account-tax-lines.mjs.map +1 -1
- package/resources/qbd/accounts.d.mts +645 -0
- package/resources/qbd/accounts.d.mts.map +1 -0
- package/resources/qbd/accounts.d.ts +11 -14
- package/resources/qbd/accounts.d.ts.map +1 -1
- package/resources/qbd/accounts.js +9 -7
- package/resources/qbd/accounts.js.map +1 -1
- package/resources/qbd/accounts.mjs +9 -7
- package/resources/qbd/accounts.mjs.map +1 -1
- package/resources/qbd/bill-check-payments.d.mts +918 -0
- package/resources/qbd/bill-check-payments.d.mts.map +1 -0
- package/resources/qbd/bill-check-payments.d.ts +16 -21
- package/resources/qbd/bill-check-payments.d.ts.map +1 -1
- package/resources/qbd/bill-check-payments.js +14 -16
- package/resources/qbd/bill-check-payments.js.map +1 -1
- package/resources/qbd/bill-check-payments.mjs +13 -14
- package/resources/qbd/bill-check-payments.mjs.map +1 -1
- package/resources/qbd/bill-credit-card-payments.d.mts +714 -0
- package/resources/qbd/bill-credit-card-payments.d.mts.map +1 -0
- package/resources/qbd/bill-credit-card-payments.d.ts +14 -18
- package/resources/qbd/bill-credit-card-payments.d.ts.map +1 -1
- package/resources/qbd/bill-credit-card-payments.js +15 -13
- package/resources/qbd/bill-credit-card-payments.js.map +1 -1
- package/resources/qbd/bill-credit-card-payments.mjs +14 -11
- package/resources/qbd/bill-credit-card-payments.mjs.map +1 -1
- package/resources/qbd/bills.d.mts +2644 -0
- package/resources/qbd/bills.d.mts.map +1 -0
- package/resources/qbd/bills.d.ts +17 -22
- package/resources/qbd/bills.d.ts.map +1 -1
- package/resources/qbd/bills.js +14 -16
- package/resources/qbd/bills.js.map +1 -1
- package/resources/qbd/bills.mjs +13 -14
- package/resources/qbd/bills.mjs.map +1 -1
- package/resources/qbd/build-assemblies.d.mts +698 -0
- package/resources/qbd/build-assemblies.d.mts.map +1 -0
- package/resources/qbd/build-assemblies.d.ts +16 -21
- package/resources/qbd/build-assemblies.d.ts.map +1 -1
- package/resources/qbd/build-assemblies.js +14 -16
- package/resources/qbd/build-assemblies.js.map +1 -1
- package/resources/qbd/build-assemblies.mjs +13 -14
- package/resources/qbd/build-assemblies.mjs.map +1 -1
- package/resources/qbd/checks.d.mts +2607 -0
- package/resources/qbd/checks.d.mts.map +1 -0
- package/resources/qbd/checks.d.ts +16 -21
- package/resources/qbd/checks.d.ts.map +1 -1
- package/resources/qbd/checks.js +14 -16
- package/resources/qbd/checks.js.map +1 -1
- package/resources/qbd/checks.mjs +13 -14
- package/resources/qbd/checks.mjs.map +1 -1
- package/resources/qbd/classes.d.mts +344 -0
- package/resources/qbd/classes.d.mts.map +1 -0
- package/resources/qbd/classes.d.ts +11 -14
- package/resources/qbd/classes.d.ts.map +1 -1
- package/resources/qbd/classes.js +9 -7
- package/resources/qbd/classes.js.map +1 -1
- package/resources/qbd/classes.mjs +9 -7
- package/resources/qbd/classes.mjs.map +1 -1
- package/resources/qbd/company.d.mts +361 -0
- package/resources/qbd/company.d.mts.map +1 -0
- package/resources/qbd/company.d.ts +5 -5
- package/resources/qbd/company.d.ts.map +1 -1
- package/resources/qbd/company.js +3 -2
- package/resources/qbd/company.js.map +1 -1
- package/resources/qbd/company.mjs +3 -2
- package/resources/qbd/company.mjs.map +1 -1
- package/resources/qbd/credit-card-charges.d.mts +2316 -0
- package/resources/qbd/credit-card-charges.d.mts.map +1 -0
- package/resources/qbd/credit-card-charges.d.ts +16 -21
- package/resources/qbd/credit-card-charges.d.ts.map +1 -1
- package/resources/qbd/credit-card-charges.js +14 -16
- package/resources/qbd/credit-card-charges.js.map +1 -1
- package/resources/qbd/credit-card-charges.mjs +13 -14
- package/resources/qbd/credit-card-charges.mjs.map +1 -1
- package/resources/qbd/credit-card-credits.d.mts +2311 -0
- package/resources/qbd/credit-card-credits.d.mts.map +1 -0
- package/resources/qbd/credit-card-credits.d.ts +16 -21
- package/resources/qbd/credit-card-credits.d.ts.map +1 -1
- package/resources/qbd/credit-card-credits.js +14 -16
- package/resources/qbd/credit-card-credits.js.map +1 -1
- package/resources/qbd/credit-card-credits.mjs +13 -14
- package/resources/qbd/credit-card-credits.mjs.map +1 -1
- package/resources/qbd/credit-card-refunds.d.mts +1012 -0
- package/resources/qbd/credit-card-refunds.d.mts.map +1 -0
- package/resources/qbd/credit-card-refunds.d.ts +14 -18
- package/resources/qbd/credit-card-refunds.d.ts.map +1 -1
- package/resources/qbd/credit-card-refunds.js +12 -14
- package/resources/qbd/credit-card-refunds.js.map +1 -1
- package/resources/qbd/credit-card-refunds.mjs +11 -12
- package/resources/qbd/credit-card-refunds.mjs.map +1 -1
- package/resources/qbd/credit-memos.d.mts +2718 -0
- package/resources/qbd/credit-memos.d.mts.map +1 -0
- package/resources/qbd/credit-memos.d.ts +16 -21
- package/resources/qbd/credit-memos.d.ts.map +1 -1
- package/resources/qbd/credit-memos.js +14 -16
- package/resources/qbd/credit-memos.js.map +1 -1
- package/resources/qbd/credit-memos.mjs +13 -14
- package/resources/qbd/credit-memos.mjs.map +1 -1
- package/resources/qbd/currencies.d.mts +439 -0
- package/resources/qbd/currencies.d.mts.map +1 -0
- package/resources/qbd/currencies.d.ts +11 -14
- package/resources/qbd/currencies.d.ts.map +1 -1
- package/resources/qbd/currencies.js +9 -7
- package/resources/qbd/currencies.js.map +1 -1
- package/resources/qbd/currencies.mjs +9 -7
- package/resources/qbd/currencies.mjs.map +1 -1
- package/resources/qbd/customer-types.d.mts +300 -0
- package/resources/qbd/customer-types.d.mts.map +1 -0
- package/resources/qbd/customer-types.d.ts +9 -11
- package/resources/qbd/customer-types.d.ts.map +1 -1
- package/resources/qbd/customer-types.js +7 -5
- package/resources/qbd/customer-types.js.map +1 -1
- package/resources/qbd/customer-types.mjs +7 -5
- package/resources/qbd/customer-types.mjs.map +1 -1
- package/resources/qbd/customers.d.mts +2163 -0
- package/resources/qbd/customers.d.mts.map +1 -0
- package/resources/qbd/customers.d.ts +14 -18
- package/resources/qbd/customers.d.ts.map +1 -1
- package/resources/qbd/customers.js +12 -14
- package/resources/qbd/customers.js.map +1 -1
- package/resources/qbd/customers.mjs +11 -12
- package/resources/qbd/customers.mjs.map +1 -1
- package/resources/qbd/date-driven-terms.d.mts +295 -0
- package/resources/qbd/date-driven-terms.d.mts.map +1 -0
- package/resources/qbd/date-driven-terms.d.ts +9 -11
- package/resources/qbd/date-driven-terms.d.ts.map +1 -1
- package/resources/qbd/date-driven-terms.js +7 -5
- package/resources/qbd/date-driven-terms.js.map +1 -1
- package/resources/qbd/date-driven-terms.mjs +7 -5
- package/resources/qbd/date-driven-terms.mjs.map +1 -1
- package/resources/qbd/deleted-list-objects.d.mts +105 -0
- package/resources/qbd/deleted-list-objects.d.mts.map +1 -0
- package/resources/qbd/deleted-list-objects.d.ts +5 -5
- package/resources/qbd/deleted-list-objects.d.ts.map +1 -1
- package/resources/qbd/deleted-list-objects.js +3 -2
- package/resources/qbd/deleted-list-objects.js.map +1 -1
- package/resources/qbd/deleted-list-objects.mjs +3 -2
- package/resources/qbd/deleted-list-objects.mjs.map +1 -1
- package/resources/qbd/deleted-transactions.d.mts +111 -0
- package/resources/qbd/deleted-transactions.d.mts.map +1 -0
- package/resources/qbd/deleted-transactions.d.ts +5 -5
- package/resources/qbd/deleted-transactions.d.ts.map +1 -1
- package/resources/qbd/deleted-transactions.js +3 -2
- package/resources/qbd/deleted-transactions.js.map +1 -1
- package/resources/qbd/deleted-transactions.mjs +3 -2
- package/resources/qbd/deleted-transactions.mjs.map +1 -1
- package/resources/qbd/discount-items.d.mts +642 -0
- package/resources/qbd/discount-items.d.mts.map +1 -0
- package/resources/qbd/discount-items.d.ts +14 -18
- package/resources/qbd/discount-items.d.ts.map +1 -1
- package/resources/qbd/discount-items.js +12 -14
- package/resources/qbd/discount-items.js.map +1 -1
- package/resources/qbd/discount-items.mjs +11 -12
- package/resources/qbd/discount-items.mjs.map +1 -1
- package/resources/qbd/employees.d.mts +1811 -0
- package/resources/qbd/employees.d.mts.map +1 -0
- package/resources/qbd/employees.d.ts +11 -14
- package/resources/qbd/employees.d.ts.map +1 -1
- package/resources/qbd/employees.js +9 -7
- package/resources/qbd/employees.js.map +1 -1
- package/resources/qbd/employees.mjs +9 -7
- package/resources/qbd/employees.mjs.map +1 -1
- package/resources/qbd/estimates.d.mts +2584 -0
- package/resources/qbd/estimates.d.mts.map +1 -0
- package/resources/qbd/estimates.d.ts +16 -21
- package/resources/qbd/estimates.d.ts.map +1 -1
- package/resources/qbd/estimates.js +14 -16
- package/resources/qbd/estimates.js.map +1 -1
- package/resources/qbd/estimates.mjs +13 -14
- package/resources/qbd/estimates.mjs.map +1 -1
- package/resources/qbd/index.d.mts +57 -0
- package/resources/qbd/index.d.mts.map +1 -0
- package/resources/qbd/index.d.ts +34 -34
- package/resources/qbd/index.d.ts.map +1 -1
- package/resources/qbd/index.js +2 -36
- package/resources/qbd/index.js.map +1 -1
- package/resources/qbd/index.mjs +34 -34
- package/resources/qbd/index.mjs.map +1 -1
- package/resources/qbd/inventory-adjustments.d.mts +893 -0
- package/resources/qbd/inventory-adjustments.d.mts.map +1 -0
- package/resources/qbd/inventory-adjustments.d.ts +13 -17
- package/resources/qbd/inventory-adjustments.d.ts.map +1 -1
- package/resources/qbd/inventory-adjustments.js +11 -9
- package/resources/qbd/inventory-adjustments.js.map +1 -1
- package/resources/qbd/inventory-adjustments.mjs +11 -9
- package/resources/qbd/inventory-adjustments.mjs.map +1 -1
- package/resources/qbd/inventory-assembly-items.d.mts +988 -0
- package/resources/qbd/inventory-assembly-items.d.mts.map +1 -0
- package/resources/qbd/inventory-assembly-items.d.ts +14 -18
- package/resources/qbd/inventory-assembly-items.d.ts.map +1 -1
- package/resources/qbd/inventory-assembly-items.js +15 -13
- package/resources/qbd/inventory-assembly-items.js.map +1 -1
- package/resources/qbd/inventory-assembly-items.mjs +14 -11
- package/resources/qbd/inventory-assembly-items.mjs.map +1 -1
- package/resources/qbd/inventory-items.d.mts +898 -0
- package/resources/qbd/inventory-items.d.mts.map +1 -0
- package/resources/qbd/inventory-items.d.ts +14 -18
- package/resources/qbd/inventory-items.d.ts.map +1 -1
- package/resources/qbd/inventory-items.js +12 -14
- package/resources/qbd/inventory-items.js.map +1 -1
- package/resources/qbd/inventory-items.mjs +11 -12
- package/resources/qbd/inventory-items.mjs.map +1 -1
- package/resources/qbd/inventory-sites.d.mts +537 -0
- package/resources/qbd/inventory-sites.d.mts.map +1 -0
- package/resources/qbd/inventory-sites.d.ts +11 -14
- package/resources/qbd/inventory-sites.d.ts.map +1 -1
- package/resources/qbd/inventory-sites.js +9 -7
- package/resources/qbd/inventory-sites.js.map +1 -1
- package/resources/qbd/inventory-sites.mjs +9 -7
- package/resources/qbd/inventory-sites.mjs.map +1 -1
- package/resources/qbd/invoices.d.mts +2942 -0
- package/resources/qbd/invoices.d.mts.map +1 -0
- package/resources/qbd/invoices.d.ts +16 -21
- package/resources/qbd/invoices.d.ts.map +1 -1
- package/resources/qbd/invoices.js +14 -16
- package/resources/qbd/invoices.js.map +1 -1
- package/resources/qbd/invoices.mjs +13 -14
- package/resources/qbd/invoices.mjs.map +1 -1
- package/resources/qbd/item-groups.d.mts +548 -0
- package/resources/qbd/item-groups.d.mts.map +1 -0
- package/resources/qbd/item-groups.d.ts +14 -18
- package/resources/qbd/item-groups.d.ts.map +1 -1
- package/resources/qbd/item-groups.js +12 -14
- package/resources/qbd/item-groups.js.map +1 -1
- package/resources/qbd/item-groups.mjs +11 -12
- package/resources/qbd/item-groups.mjs.map +1 -1
- package/resources/qbd/item-receipts.d.mts +2416 -0
- package/resources/qbd/item-receipts.d.mts.map +1 -0
- package/resources/qbd/item-receipts.d.ts +16 -21
- package/resources/qbd/item-receipts.d.ts.map +1 -1
- package/resources/qbd/item-receipts.js +14 -16
- package/resources/qbd/item-receipts.js.map +1 -1
- package/resources/qbd/item-receipts.mjs +13 -14
- package/resources/qbd/item-receipts.mjs.map +1 -1
- package/resources/qbd/item-sites.d.mts +244 -0
- package/resources/qbd/item-sites.d.mts.map +1 -0
- package/resources/qbd/item-sites.d.ts +10 -12
- package/resources/qbd/item-sites.d.ts.map +1 -1
- package/resources/qbd/item-sites.js +9 -11
- package/resources/qbd/item-sites.js.map +1 -1
- package/resources/qbd/item-sites.mjs +8 -9
- package/resources/qbd/item-sites.mjs.map +1 -1
- package/resources/qbd/journal-entries.d.mts +937 -0
- package/resources/qbd/journal-entries.d.mts.map +1 -0
- package/resources/qbd/journal-entries.d.ts +16 -21
- package/resources/qbd/journal-entries.d.ts.map +1 -1
- package/resources/qbd/journal-entries.js +14 -16
- package/resources/qbd/journal-entries.js.map +1 -1
- package/resources/qbd/journal-entries.mjs +13 -14
- package/resources/qbd/journal-entries.mjs.map +1 -1
- package/resources/qbd/non-inventory-items.d.mts +1016 -0
- package/resources/qbd/non-inventory-items.d.mts.map +1 -0
- package/resources/qbd/non-inventory-items.d.ts +14 -18
- package/resources/qbd/non-inventory-items.d.ts.map +1 -1
- package/resources/qbd/non-inventory-items.js +12 -14
- package/resources/qbd/non-inventory-items.js.map +1 -1
- package/resources/qbd/non-inventory-items.mjs +11 -12
- package/resources/qbd/non-inventory-items.mjs.map +1 -1
- package/resources/qbd/other-charge-items.d.mts +948 -0
- package/resources/qbd/other-charge-items.d.mts.map +1 -0
- package/resources/qbd/other-charge-items.d.ts +14 -18
- package/resources/qbd/other-charge-items.d.ts.map +1 -1
- package/resources/qbd/other-charge-items.js +12 -14
- package/resources/qbd/other-charge-items.js.map +1 -1
- package/resources/qbd/other-charge-items.mjs +11 -12
- package/resources/qbd/other-charge-items.mjs.map +1 -1
- package/resources/qbd/other-names.d.mts +711 -0
- package/resources/qbd/other-names.d.mts.map +1 -0
- package/resources/qbd/other-names.d.ts +11 -14
- package/resources/qbd/other-names.d.ts.map +1 -1
- package/resources/qbd/other-names.js +9 -7
- package/resources/qbd/other-names.js.map +1 -1
- package/resources/qbd/other-names.mjs +9 -7
- package/resources/qbd/other-names.mjs.map +1 -1
- package/resources/qbd/payment-methods.d.mts +258 -0
- package/resources/qbd/payment-methods.d.mts.map +1 -0
- package/resources/qbd/payment-methods.d.ts +9 -11
- package/resources/qbd/payment-methods.d.ts.map +1 -1
- package/resources/qbd/payment-methods.js +7 -5
- package/resources/qbd/payment-methods.js.map +1 -1
- package/resources/qbd/payment-methods.mjs +7 -5
- package/resources/qbd/payment-methods.mjs.map +1 -1
- package/resources/qbd/payroll-wage-items.d.mts +297 -0
- package/resources/qbd/payroll-wage-items.d.mts.map +1 -0
- package/resources/qbd/payroll-wage-items.d.ts +42 -15
- package/resources/qbd/payroll-wage-items.d.ts.map +1 -1
- package/resources/qbd/payroll-wage-items.js +10 -12
- package/resources/qbd/payroll-wage-items.js.map +1 -1
- package/resources/qbd/payroll-wage-items.mjs +9 -10
- package/resources/qbd/payroll-wage-items.mjs.map +1 -1
- package/resources/qbd/preferences.d.mts +599 -0
- package/resources/qbd/preferences.d.mts.map +1 -0
- package/resources/qbd/preferences.d.ts +5 -5
- package/resources/qbd/preferences.d.ts.map +1 -1
- package/resources/qbd/preferences.js +3 -2
- package/resources/qbd/preferences.js.map +1 -1
- package/resources/qbd/preferences.mjs +3 -2
- package/resources/qbd/preferences.mjs.map +1 -1
- package/resources/qbd/price-levels.d.mts +509 -0
- package/resources/qbd/price-levels.d.mts.map +1 -0
- package/resources/qbd/price-levels.d.ts +11 -14
- package/resources/qbd/price-levels.d.ts.map +1 -1
- package/resources/qbd/price-levels.js +9 -7
- package/resources/qbd/price-levels.js.map +1 -1
- package/resources/qbd/price-levels.mjs +9 -7
- package/resources/qbd/price-levels.mjs.map +1 -1
- package/resources/qbd/purchase-orders.d.mts +2632 -0
- package/resources/qbd/purchase-orders.d.mts.map +1 -0
- package/resources/qbd/purchase-orders.d.ts +16 -21
- package/resources/qbd/purchase-orders.d.ts.map +1 -1
- package/resources/qbd/purchase-orders.js +14 -16
- package/resources/qbd/purchase-orders.js.map +1 -1
- package/resources/qbd/purchase-orders.mjs +13 -14
- package/resources/qbd/purchase-orders.mjs.map +1 -1
- package/resources/qbd/qbd.d.mts +261 -0
- package/resources/qbd/qbd.d.mts.map +1 -0
- package/resources/qbd/qbd.d.ts +39 -39
- package/resources/qbd/qbd.d.ts.map +1 -1
- package/resources/qbd/qbd.js +59 -114
- package/resources/qbd/qbd.js.map +1 -1
- package/resources/qbd/qbd.mjs +37 -70
- package/resources/qbd/qbd.mjs.map +1 -1
- package/resources/qbd/receive-payments.d.mts +1358 -0
- package/resources/qbd/receive-payments.d.mts.map +1 -0
- package/resources/qbd/receive-payments.d.ts +16 -21
- package/resources/qbd/receive-payments.d.ts.map +1 -1
- package/resources/qbd/receive-payments.js +14 -16
- package/resources/qbd/receive-payments.js.map +1 -1
- package/resources/qbd/receive-payments.mjs +13 -14
- package/resources/qbd/receive-payments.mjs.map +1 -1
- package/resources/qbd/sales-orders.d.mts +2705 -0
- package/resources/qbd/sales-orders.d.mts.map +1 -0
- package/resources/qbd/sales-orders.d.ts +16 -21
- package/resources/qbd/sales-orders.d.ts.map +1 -1
- package/resources/qbd/sales-orders.js +14 -16
- package/resources/qbd/sales-orders.js.map +1 -1
- package/resources/qbd/sales-orders.mjs +13 -14
- package/resources/qbd/sales-orders.mjs.map +1 -1
- package/resources/qbd/sales-receipts.d.mts +3454 -0
- package/resources/qbd/sales-receipts.d.mts.map +1 -0
- package/resources/qbd/sales-receipts.d.ts +16 -21
- package/resources/qbd/sales-receipts.d.ts.map +1 -1
- package/resources/qbd/sales-receipts.js +14 -16
- package/resources/qbd/sales-receipts.js.map +1 -1
- package/resources/qbd/sales-receipts.mjs +13 -14
- package/resources/qbd/sales-receipts.mjs.map +1 -1
- package/resources/qbd/sales-representatives.d.mts +317 -0
- package/resources/qbd/sales-representatives.d.mts.map +1 -0
- package/resources/qbd/sales-representatives.d.ts +11 -14
- package/resources/qbd/sales-representatives.d.ts.map +1 -1
- package/resources/qbd/sales-representatives.js +9 -7
- package/resources/qbd/sales-representatives.js.map +1 -1
- package/resources/qbd/sales-representatives.mjs +9 -7
- package/resources/qbd/sales-representatives.mjs.map +1 -1
- package/resources/qbd/sales-tax-codes.d.mts +369 -0
- package/resources/qbd/sales-tax-codes.d.mts.map +1 -0
- package/resources/qbd/sales-tax-codes.d.ts +11 -14
- package/resources/qbd/sales-tax-codes.d.ts.map +1 -1
- package/resources/qbd/sales-tax-codes.js +9 -7
- package/resources/qbd/sales-tax-codes.js.map +1 -1
- package/resources/qbd/sales-tax-codes.mjs +9 -7
- package/resources/qbd/sales-tax-codes.mjs.map +1 -1
- package/resources/qbd/sales-tax-items.d.mts +518 -0
- package/resources/qbd/sales-tax-items.d.mts.map +1 -0
- package/resources/qbd/sales-tax-items.d.ts +14 -18
- package/resources/qbd/sales-tax-items.d.ts.map +1 -1
- package/resources/qbd/sales-tax-items.js +12 -14
- package/resources/qbd/sales-tax-items.js.map +1 -1
- package/resources/qbd/sales-tax-items.mjs +11 -12
- package/resources/qbd/sales-tax-items.mjs.map +1 -1
- package/resources/qbd/service-items.d.mts +987 -0
- package/resources/qbd/service-items.d.mts.map +1 -0
- package/resources/qbd/service-items.d.ts +14 -18
- package/resources/qbd/service-items.d.ts.map +1 -1
- package/resources/qbd/service-items.js +12 -14
- package/resources/qbd/service-items.js.map +1 -1
- package/resources/qbd/service-items.mjs +11 -12
- package/resources/qbd/service-items.mjs.map +1 -1
- package/resources/qbd/standard-terms.d.mts +273 -0
- package/resources/qbd/standard-terms.d.mts.map +1 -0
- package/resources/qbd/standard-terms.d.ts +9 -11
- package/resources/qbd/standard-terms.d.ts.map +1 -1
- package/resources/qbd/standard-terms.js +7 -5
- package/resources/qbd/standard-terms.js.map +1 -1
- package/resources/qbd/standard-terms.mjs +7 -5
- package/resources/qbd/standard-terms.mjs.map +1 -1
- package/resources/qbd/subtotal-items.d.mts +383 -0
- package/resources/qbd/subtotal-items.d.mts.map +1 -0
- package/resources/qbd/subtotal-items.d.ts +14 -18
- package/resources/qbd/subtotal-items.d.ts.map +1 -1
- package/resources/qbd/subtotal-items.js +12 -14
- package/resources/qbd/subtotal-items.js.map +1 -1
- package/resources/qbd/subtotal-items.mjs +11 -12
- package/resources/qbd/subtotal-items.mjs.map +1 -1
- package/resources/qbd/templates.d.mts +107 -0
- package/resources/qbd/templates.d.mts.map +1 -0
- package/resources/qbd/templates.d.ts +5 -5
- package/resources/qbd/templates.d.ts.map +1 -1
- package/resources/qbd/templates.js +3 -2
- package/resources/qbd/templates.js.map +1 -1
- package/resources/qbd/templates.mjs +3 -2
- package/resources/qbd/templates.mjs.map +1 -1
- package/resources/qbd/time-tracking-activities.d.mts +560 -0
- package/resources/qbd/time-tracking-activities.d.mts.map +1 -0
- package/resources/qbd/time-tracking-activities.d.ts +16 -21
- package/resources/qbd/time-tracking-activities.d.ts.map +1 -1
- package/resources/qbd/time-tracking-activities.js +17 -15
- package/resources/qbd/time-tracking-activities.js.map +1 -1
- package/resources/qbd/time-tracking-activities.mjs +16 -13
- package/resources/qbd/time-tracking-activities.mjs.map +1 -1
- package/resources/qbd/transactions.d.mts +356 -0
- package/resources/qbd/transactions.d.mts.map +1 -0
- package/resources/qbd/transactions.d.ts +10 -12
- package/resources/qbd/transactions.d.ts.map +1 -1
- package/resources/qbd/transactions.js +9 -11
- package/resources/qbd/transactions.js.map +1 -1
- package/resources/qbd/transactions.mjs +8 -9
- package/resources/qbd/transactions.mjs.map +1 -1
- package/resources/qbd/transfers.d.mts +331 -0
- package/resources/qbd/transfers.d.mts.map +1 -0
- package/resources/qbd/transfers.d.ts +14 -18
- package/resources/qbd/transfers.d.ts.map +1 -1
- package/resources/qbd/transfers.js +12 -14
- package/resources/qbd/transfers.js.map +1 -1
- package/resources/qbd/transfers.mjs +11 -12
- package/resources/qbd/transfers.mjs.map +1 -1
- package/resources/qbd/unit-of-measure-sets.d.mts +443 -0
- package/resources/qbd/unit-of-measure-sets.d.mts.map +1 -0
- package/resources/qbd/unit-of-measure-sets.d.ts +9 -11
- package/resources/qbd/unit-of-measure-sets.d.ts.map +1 -1
- package/resources/qbd/unit-of-measure-sets.js +7 -5
- package/resources/qbd/unit-of-measure-sets.js.map +1 -1
- package/resources/qbd/unit-of-measure-sets.mjs +7 -5
- package/resources/qbd/unit-of-measure-sets.mjs.map +1 -1
- package/resources/qbd/vendor-credits.d.mts +2387 -0
- package/resources/qbd/vendor-credits.d.mts.map +1 -0
- package/resources/qbd/vendor-credits.d.ts +16 -21
- package/resources/qbd/vendor-credits.d.ts.map +1 -1
- package/resources/qbd/vendor-credits.js +14 -16
- package/resources/qbd/vendor-credits.js.map +1 -1
- package/resources/qbd/vendor-credits.mjs +13 -14
- package/resources/qbd/vendor-credits.mjs.map +1 -1
- package/resources/qbd/vendors.d.mts +1734 -0
- package/resources/qbd/vendors.d.mts.map +1 -0
- package/resources/qbd/vendors.d.ts +14 -18
- package/resources/qbd/vendors.d.ts.map +1 -1
- package/resources/qbd/vendors.js +12 -14
- package/resources/qbd/vendors.js.map +1 -1
- package/resources/qbd/vendors.mjs +11 -12
- package/resources/qbd/vendors.mjs.map +1 -1
- package/resources/qbd.d.mts +2 -0
- package/resources/qbd.d.mts.map +1 -0
- package/resources/qbd.d.ts.map +1 -1
- package/resources/qbd.js +2 -15
- package/resources/qbd.js.map +1 -1
- package/resources.d.mts +2 -0
- package/resources.d.mts.map +1 -0
- package/resources.d.ts.map +1 -1
- package/resources.js +2 -15
- package/resources.js.map +1 -1
- package/src/api-promise.ts +2 -0
- package/src/client.ts +769 -0
- package/src/core/README.md +3 -0
- package/src/core/api-promise.ts +92 -0
- package/src/core/error.ts +130 -0
- package/src/core/pagination.ts +157 -0
- package/src/core/resource.ts +11 -0
- package/src/core/uploads.ts +2 -0
- package/src/error.ts +2 -130
- package/src/index.ts +6 -223
- package/src/internal/README.md +3 -0
- package/src/internal/builtin-types.ts +93 -0
- package/src/internal/detect-platform.ts +196 -0
- package/src/internal/errors.ts +33 -0
- package/src/internal/headers.ts +97 -0
- package/src/internal/parse.ts +50 -0
- package/src/internal/qs/formats.ts +3 -2
- package/src/internal/qs/index.ts +3 -3
- package/src/internal/qs/stringify.ts +18 -21
- package/src/internal/qs/utils.ts +16 -16
- package/src/internal/request-options.ts +91 -0
- package/src/internal/shim-types.ts +26 -0
- package/src/internal/shims.ts +107 -0
- package/src/internal/to-file.ts +154 -0
- package/src/internal/types.ts +95 -0
- package/src/internal/uploads.ts +187 -0
- package/src/internal/utils/base64.ts +40 -0
- package/src/internal/utils/bytes.ts +32 -0
- package/src/internal/utils/env.ts +18 -0
- package/src/internal/utils/log.ts +126 -0
- package/src/internal/utils/path.ts +88 -0
- package/src/internal/utils/sleep.ts +3 -0
- package/src/internal/utils/uuid.ts +17 -0
- package/src/internal/utils/values.ts +105 -0
- package/src/internal/utils.ts +8 -0
- package/src/pagination.ts +2 -60
- package/src/resource.ts +2 -11
- package/src/resources/auth-sessions.ts +4 -3
- package/src/resources/end-users.ts +33 -16
- package/src/resources/index.ts +3 -3
- package/src/resources/qbd/account-tax-lines.ts +7 -9
- package/src/resources/qbd/accounts.ts +19 -24
- package/src/resources/qbd/bill-check-payments.ts +31 -38
- package/src/resources/qbd/bill-credit-card-payments.ts +31 -30
- package/src/resources/qbd/bills.ts +28 -36
- package/src/resources/qbd/build-assemblies.ts +30 -38
- package/src/resources/qbd/checks.ts +27 -35
- package/src/resources/qbd/classes.ts +19 -20
- package/src/resources/qbd/company.ts +7 -6
- package/src/resources/qbd/credit-card-charges.ts +31 -38
- package/src/resources/qbd/credit-card-credits.ts +31 -38
- package/src/resources/qbd/credit-card-refunds.ts +26 -32
- package/src/resources/qbd/credit-memos.ts +29 -41
- package/src/resources/qbd/currencies.ts +19 -24
- package/src/resources/qbd/customer-types.ts +16 -19
- package/src/resources/qbd/customers.ts +23 -33
- package/src/resources/qbd/date-driven-terms.ts +16 -19
- package/src/resources/qbd/deleted-list-objects.ts +8 -7
- package/src/resources/qbd/deleted-transactions.ts +8 -7
- package/src/resources/qbd/discount-items.ts +25 -32
- package/src/resources/qbd/employees.ts +19 -24
- package/src/resources/qbd/estimates.ts +28 -39
- package/src/resources/qbd/index.ts +90 -90
- package/src/resources/qbd/inventory-adjustments.ts +27 -32
- package/src/resources/qbd/inventory-assembly-items.ts +31 -30
- package/src/resources/qbd/inventory-items.ts +25 -32
- package/src/resources/qbd/inventory-sites.ts +20 -28
- package/src/resources/qbd/invoices.ts +28 -39
- package/src/resources/qbd/item-groups.ts +23 -37
- package/src/resources/qbd/item-receipts.ts +29 -41
- package/src/resources/qbd/item-sites.ts +16 -24
- package/src/resources/qbd/journal-entries.ts +30 -38
- package/src/resources/qbd/non-inventory-items.ts +26 -32
- package/src/resources/qbd/other-charge-items.ts +26 -32
- package/src/resources/qbd/other-names.ts +19 -28
- package/src/resources/qbd/payment-methods.ts +16 -19
- package/src/resources/qbd/payroll-wage-items.ts +57 -26
- package/src/resources/qbd/preferences.ts +7 -6
- package/src/resources/qbd/price-levels.ts +19 -28
- package/src/resources/qbd/purchase-orders.ts +30 -38
- package/src/resources/qbd/qbd.ts +151 -187
- package/src/resources/qbd/receive-payments.ts +31 -35
- package/src/resources/qbd/sales-orders.ts +29 -41
- package/src/resources/qbd/sales-receipts.ts +30 -38
- package/src/resources/qbd/sales-representatives.ts +22 -26
- package/src/resources/qbd/sales-tax-codes.ts +20 -28
- package/src/resources/qbd/sales-tax-items.ts +25 -32
- package/src/resources/qbd/service-items.ts +24 -35
- package/src/resources/qbd/standard-terms.ts +16 -19
- package/src/resources/qbd/subtotal-items.ts +25 -32
- package/src/resources/qbd/templates.ts +7 -6
- package/src/resources/qbd/time-tracking-activities.ts +36 -36
- package/src/resources/qbd/transactions.ts +17 -22
- package/src/resources/qbd/transfers.ts +23 -33
- package/src/resources/qbd/unit-of-measure-sets.ts +17 -20
- package/src/resources/qbd/vendor-credits.ts +30 -38
- package/src/resources/qbd/vendors.ts +23 -26
- package/src/resources/qbd.ts +1 -1
- package/src/resources.ts +1 -1
- package/src/tsconfig.json +2 -2
- package/src/uploads.ts +2 -255
- package/src/version.ts +1 -1
- package/uploads.d.mts +2 -0
- package/uploads.d.mts.map +1 -0
- package/uploads.d.ts +1 -74
- package/uploads.d.ts.map +1 -1
- package/uploads.js +3 -168
- package/uploads.js.map +1 -1
- package/uploads.mjs +1 -157
- package/uploads.mjs.map +1 -1
- package/version.d.mts +2 -0
- package/version.d.mts.map +1 -0
- package/version.d.ts +1 -1
- package/version.d.ts.map +1 -1
- package/version.js +1 -1
- package/version.js.map +1 -1
- package/version.mjs +1 -1
- package/version.mjs.map +1 -1
- package/_shims/MultipartBody.d.ts +0 -9
- package/_shims/MultipartBody.d.ts.map +0 -1
- package/_shims/MultipartBody.js +0 -16
- package/_shims/MultipartBody.js.map +0 -1
- package/_shims/MultipartBody.mjs +0 -12
- package/_shims/MultipartBody.mjs.map +0 -1
- package/_shims/README.md +0 -46
- package/_shims/auto/runtime-bun.d.ts +0 -5
- package/_shims/auto/runtime-bun.d.ts.map +0 -1
- package/_shims/auto/runtime-bun.js +0 -21
- package/_shims/auto/runtime-bun.js.map +0 -1
- package/_shims/auto/runtime-bun.mjs +0 -2
- package/_shims/auto/runtime-bun.mjs.map +0 -1
- package/_shims/auto/runtime-node.d.ts +0 -5
- package/_shims/auto/runtime-node.d.ts.map +0 -1
- package/_shims/auto/runtime-node.js +0 -21
- package/_shims/auto/runtime-node.js.map +0 -1
- package/_shims/auto/runtime-node.mjs +0 -2
- package/_shims/auto/runtime-node.mjs.map +0 -1
- package/_shims/auto/runtime.d.ts +0 -5
- package/_shims/auto/runtime.d.ts.map +0 -1
- package/_shims/auto/runtime.js +0 -21
- package/_shims/auto/runtime.js.map +0 -1
- package/_shims/auto/runtime.mjs +0 -2
- package/_shims/auto/runtime.mjs.map +0 -1
- package/_shims/auto/types-node.d.ts +0 -5
- package/_shims/auto/types-node.d.ts.map +0 -1
- package/_shims/auto/types-node.js +0 -21
- package/_shims/auto/types-node.js.map +0 -1
- package/_shims/auto/types-node.mjs +0 -2
- package/_shims/auto/types-node.mjs.map +0 -1
- package/_shims/auto/types.d.ts +0 -101
- package/_shims/auto/types.js +0 -3
- package/_shims/auto/types.mjs +0 -3
- package/_shims/bun-runtime.d.ts +0 -6
- package/_shims/bun-runtime.d.ts.map +0 -1
- package/_shims/bun-runtime.js +0 -14
- package/_shims/bun-runtime.js.map +0 -1
- package/_shims/bun-runtime.mjs +0 -10
- package/_shims/bun-runtime.mjs.map +0 -1
- package/_shims/index.d.ts +0 -83
- package/_shims/index.js +0 -17
- package/_shims/index.mjs +0 -11
- package/_shims/manual-types.d.ts +0 -12
- package/_shims/manual-types.js +0 -3
- package/_shims/manual-types.mjs +0 -3
- package/_shims/node-runtime.d.ts +0 -3
- package/_shims/node-runtime.d.ts.map +0 -1
- package/_shims/node-runtime.js +0 -89
- package/_shims/node-runtime.js.map +0 -1
- package/_shims/node-runtime.mjs +0 -56
- package/_shims/node-runtime.mjs.map +0 -1
- package/_shims/node-types.d.ts +0 -42
- package/_shims/node-types.js +0 -3
- package/_shims/node-types.mjs +0 -3
- package/_shims/registry.d.ts +0 -37
- package/_shims/registry.d.ts.map +0 -1
- package/_shims/registry.js +0 -41
- package/_shims/registry.js.map +0 -1
- package/_shims/registry.mjs +0 -37
- package/_shims/registry.mjs.map +0 -1
- package/_shims/web-runtime.d.ts +0 -5
- package/_shims/web-runtime.d.ts.map +0 -1
- package/_shims/web-runtime.js +0 -78
- package/_shims/web-runtime.js.map +0 -1
- package/_shims/web-runtime.mjs +0 -71
- package/_shims/web-runtime.mjs.map +0 -1
- package/_shims/web-types.d.ts +0 -83
- package/_shims/web-types.js +0 -3
- package/_shims/web-types.mjs +0 -3
- package/core.d.ts +0 -255
- package/core.d.ts.map +0 -1
- package/core.js +0 -924
- package/core.js.map +0 -1
- package/core.mjs +0 -892
- package/core.mjs.map +0 -1
- package/shims/node.d.ts +0 -30
- package/shims/node.d.ts.map +0 -1
- package/shims/node.js +0 -31
- package/shims/node.js.map +0 -1
- package/shims/node.mjs +0 -5
- package/shims/node.mjs.map +0 -1
- package/shims/web.d.ts +0 -26
- package/shims/web.d.ts.map +0 -1
- package/shims/web.js +0 -31
- package/shims/web.js.map +0 -1
- package/shims/web.mjs +0 -5
- package/shims/web.mjs.map +0 -1
- package/src/_shims/MultipartBody.ts +0 -9
- package/src/_shims/README.md +0 -46
- package/src/_shims/auto/runtime-bun.ts +0 -4
- package/src/_shims/auto/runtime-node.ts +0 -4
- package/src/_shims/auto/runtime.ts +0 -4
- package/src/_shims/auto/types-node.ts +0 -4
- package/src/_shims/auto/types.d.ts +0 -101
- package/src/_shims/auto/types.js +0 -3
- package/src/_shims/auto/types.mjs +0 -3
- package/src/_shims/bun-runtime.ts +0 -14
- package/src/_shims/index.d.ts +0 -83
- package/src/_shims/index.js +0 -17
- package/src/_shims/index.mjs +0 -11
- package/src/_shims/manual-types.d.ts +0 -12
- package/src/_shims/manual-types.js +0 -3
- package/src/_shims/manual-types.mjs +0 -3
- package/src/_shims/node-runtime.ts +0 -81
- package/src/_shims/node-types.d.ts +0 -42
- package/src/_shims/node-types.js +0 -3
- package/src/_shims/node-types.mjs +0 -3
- package/src/_shims/registry.ts +0 -67
- package/src/_shims/web-runtime.ts +0 -103
- package/src/_shims/web-types.d.ts +0 -83
- package/src/_shims/web-types.js +0 -3
- package/src/_shims/web-types.mjs +0 -3
- package/src/core.ts +0 -1236
- package/src/shims/node.ts +0 -50
- package/src/shims/web.ts +0 -50
|
@@ -0,0 +1,2607 @@
|
|
|
1
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
2
|
+
import { APIPromise } from "../../core/api-promise.mjs";
|
|
3
|
+
import { CursorPage, type CursorPageParams, PagePromise } from "../../core/pagination.mjs";
|
|
4
|
+
import { RequestOptions } from "../../internal/request-options.mjs";
|
|
5
|
+
export declare class Checks extends APIResource {
|
|
6
|
+
/**
|
|
7
|
+
* Creates a non-payroll check from a bank account. QuickBooks uses this request
|
|
8
|
+
* for direct expense disbursements; to pay vendor bills or payroll liabilities you
|
|
9
|
+
* must use the dedicated bill-payment or payroll transactions instead.
|
|
10
|
+
*
|
|
11
|
+
* @example
|
|
12
|
+
* ```ts
|
|
13
|
+
* const check = await conductor.qbd.checks.create({
|
|
14
|
+
* bankAccountId: '80000001-1234567890',
|
|
15
|
+
* transactionDate: '2024-10-01',
|
|
16
|
+
* conductorEndUserId: 'end_usr_1234567abcdefg',
|
|
17
|
+
* });
|
|
18
|
+
* ```
|
|
19
|
+
*/
|
|
20
|
+
create(params: CheckCreateParams, options?: RequestOptions): APIPromise<Check>;
|
|
21
|
+
/**
|
|
22
|
+
* Retrieves a check by ID.
|
|
23
|
+
*
|
|
24
|
+
* **IMPORTANT:** If you need to fetch multiple specific checks by ID, use the list
|
|
25
|
+
* endpoint instead with the `ids` parameter. It accepts an array of IDs so you can
|
|
26
|
+
* batch the request into a single call, which is significantly faster.
|
|
27
|
+
*
|
|
28
|
+
* NOTE: The response automatically includes any linked transactions.
|
|
29
|
+
*
|
|
30
|
+
* @example
|
|
31
|
+
* ```ts
|
|
32
|
+
* const check = await conductor.qbd.checks.retrieve(
|
|
33
|
+
* '123ABC-1234567890',
|
|
34
|
+
* { conductorEndUserId: 'end_usr_1234567abcdefg' },
|
|
35
|
+
* );
|
|
36
|
+
* ```
|
|
37
|
+
*/
|
|
38
|
+
retrieve(id: string, params: CheckRetrieveParams, options?: RequestOptions): APIPromise<Check>;
|
|
39
|
+
/**
|
|
40
|
+
* Updates a standard check so you can adjust the issuing account, payee details,
|
|
41
|
+
* memo, transaction date, or expense and item lines. This request cannot modify
|
|
42
|
+
* checks created through the bill-payment workflow.
|
|
43
|
+
*
|
|
44
|
+
* @example
|
|
45
|
+
* ```ts
|
|
46
|
+
* const check = await conductor.qbd.checks.update(
|
|
47
|
+
* '123ABC-1234567890',
|
|
48
|
+
* {
|
|
49
|
+
* revisionNumber: '1721172183',
|
|
50
|
+
* conductorEndUserId: 'end_usr_1234567abcdefg',
|
|
51
|
+
* },
|
|
52
|
+
* );
|
|
53
|
+
* ```
|
|
54
|
+
*/
|
|
55
|
+
update(id: string, params: CheckUpdateParams, options?: RequestOptions): APIPromise<Check>;
|
|
56
|
+
/**
|
|
57
|
+
* Returns a list of checks. Use the `cursor` parameter to paginate through the
|
|
58
|
+
* results.
|
|
59
|
+
*
|
|
60
|
+
* @example
|
|
61
|
+
* ```ts
|
|
62
|
+
* // Automatically fetches more pages as needed.
|
|
63
|
+
* for await (const check of conductor.qbd.checks.list({
|
|
64
|
+
* conductorEndUserId: 'end_usr_1234567abcdefg',
|
|
65
|
+
* })) {
|
|
66
|
+
* // ...
|
|
67
|
+
* }
|
|
68
|
+
* ```
|
|
69
|
+
*/
|
|
70
|
+
list(params: CheckListParams, options?: RequestOptions): PagePromise<ChecksCursorPage, Check>;
|
|
71
|
+
/**
|
|
72
|
+
* Permanently deletes a a check. The deletion will fail if the check is currently
|
|
73
|
+
* in use or has any linked transactions that are in use.
|
|
74
|
+
*
|
|
75
|
+
* @example
|
|
76
|
+
* ```ts
|
|
77
|
+
* const check = await conductor.qbd.checks.delete(
|
|
78
|
+
* '123ABC-1234567890',
|
|
79
|
+
* { conductorEndUserId: 'end_usr_1234567abcdefg' },
|
|
80
|
+
* );
|
|
81
|
+
* ```
|
|
82
|
+
*/
|
|
83
|
+
delete(id: string, params: CheckDeleteParams, options?: RequestOptions): APIPromise<CheckDeleteResponse>;
|
|
84
|
+
}
|
|
85
|
+
export type ChecksCursorPage = CursorPage<Check>;
|
|
86
|
+
export interface Check {
|
|
87
|
+
/**
|
|
88
|
+
* The unique identifier assigned by QuickBooks to this check. This ID is unique
|
|
89
|
+
* across all transaction types.
|
|
90
|
+
*/
|
|
91
|
+
id: string;
|
|
92
|
+
/**
|
|
93
|
+
* The address that is printed on the check.
|
|
94
|
+
*/
|
|
95
|
+
address: Check.Address | null;
|
|
96
|
+
/**
|
|
97
|
+
* The total monetary amount of this check, represented as a decimal string. This
|
|
98
|
+
* equals the sum of the amounts in the check's expense lines, item lines, and item
|
|
99
|
+
* group lines.
|
|
100
|
+
*/
|
|
101
|
+
amount: string;
|
|
102
|
+
/**
|
|
103
|
+
* The monetary amount of this check converted to the home currency of the
|
|
104
|
+
* QuickBooks company file. Represented as a decimal string.
|
|
105
|
+
*/
|
|
106
|
+
amountInHomeCurrency: string | null;
|
|
107
|
+
/**
|
|
108
|
+
* The bank account from which the funds are being drawn for this check; e.g.,
|
|
109
|
+
* Checking or Savings. This check will decrease the balance of this account.
|
|
110
|
+
*/
|
|
111
|
+
bankAccount: Check.BankAccount;
|
|
112
|
+
/**
|
|
113
|
+
* The date and time when this check was created, in ISO 8601 format
|
|
114
|
+
* (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local
|
|
115
|
+
* timezone of the end-user's computer.
|
|
116
|
+
*/
|
|
117
|
+
createdAt: string;
|
|
118
|
+
/**
|
|
119
|
+
* The check's currency. For built-in currencies, the name and code are standard
|
|
120
|
+
* international values. For user-defined currencies, all values are editable.
|
|
121
|
+
*/
|
|
122
|
+
currency: Check.Currency | null;
|
|
123
|
+
/**
|
|
124
|
+
* The custom fields for the check object, added as user-defined data extensions,
|
|
125
|
+
* not included in the standard QuickBooks object.
|
|
126
|
+
*/
|
|
127
|
+
customFields: Array<Check.CustomField>;
|
|
128
|
+
/**
|
|
129
|
+
* The market exchange rate between this check's currency and the home currency in
|
|
130
|
+
* QuickBooks at the time of this transaction. Represented as a decimal value
|
|
131
|
+
* (e.g., 1.2345 for 1 EUR = 1.2345 USD if USD is the home currency).
|
|
132
|
+
*/
|
|
133
|
+
exchangeRate: number | null;
|
|
134
|
+
/**
|
|
135
|
+
* The check's expense lines, each representing one line in this expense.
|
|
136
|
+
*/
|
|
137
|
+
expenseLines: Array<Check.ExpenseLine>;
|
|
138
|
+
/**
|
|
139
|
+
* A globally unique identifier (GUID) you, the developer, can provide for tracking
|
|
140
|
+
* this object in your external system. This field is immutable and can only be set
|
|
141
|
+
* during object creation.
|
|
142
|
+
*/
|
|
143
|
+
externalId: string | null;
|
|
144
|
+
/**
|
|
145
|
+
* Indicates whether this check has not been completed.
|
|
146
|
+
*/
|
|
147
|
+
isPending: boolean | null;
|
|
148
|
+
/**
|
|
149
|
+
* Indicates whether this check is included in the queue of documents for
|
|
150
|
+
* QuickBooks to print.
|
|
151
|
+
*/
|
|
152
|
+
isQueuedForPrint: boolean | null;
|
|
153
|
+
/**
|
|
154
|
+
* The check's item group lines, each representing a predefined set of items
|
|
155
|
+
* bundled together because they are commonly purchased together or grouped for
|
|
156
|
+
* faster entry.
|
|
157
|
+
*/
|
|
158
|
+
itemGroupLines: Array<Check.ItemGroupLine>;
|
|
159
|
+
/**
|
|
160
|
+
* The check's item lines, each representing the purchase of a specific item or
|
|
161
|
+
* service.
|
|
162
|
+
*/
|
|
163
|
+
itemLines: Array<Check.ItemLine>;
|
|
164
|
+
/**
|
|
165
|
+
* The check's linked transactions, such as payments applied, credits used, or
|
|
166
|
+
* associated purchase orders.
|
|
167
|
+
*
|
|
168
|
+
* **IMPORTANT**: You must specify the parameter `includeLinkedTransactions` when
|
|
169
|
+
* fetching a list of checks to receive this field because it is not returned by
|
|
170
|
+
* default.
|
|
171
|
+
*/
|
|
172
|
+
linkedTransactions: Array<Check.LinkedTransaction>;
|
|
173
|
+
/**
|
|
174
|
+
* The memo that is printed on this check.
|
|
175
|
+
*/
|
|
176
|
+
memo: string | null;
|
|
177
|
+
/**
|
|
178
|
+
* The type of object. This value is always `"qbd_check"`.
|
|
179
|
+
*/
|
|
180
|
+
objectType: 'qbd_check';
|
|
181
|
+
/**
|
|
182
|
+
* The person or company who will receive this check.
|
|
183
|
+
*/
|
|
184
|
+
payee: Check.Payee | null;
|
|
185
|
+
/**
|
|
186
|
+
* The case-sensitive user-defined reference number for this check, which can be
|
|
187
|
+
* used to identify the transaction in QuickBooks. This value is not required to be
|
|
188
|
+
* unique and can be arbitrarily changed by the QuickBooks user.
|
|
189
|
+
*
|
|
190
|
+
* **IMPORTANT**: For checks, this field is the check number.
|
|
191
|
+
*/
|
|
192
|
+
refNumber: string | null;
|
|
193
|
+
/**
|
|
194
|
+
* The current QuickBooks-assigned revision number of this check object, which
|
|
195
|
+
* changes each time the object is modified. When updating this object, you must
|
|
196
|
+
* provide the most recent `revisionNumber` to ensure you're working with the
|
|
197
|
+
* latest data; otherwise, the update will return an error.
|
|
198
|
+
*/
|
|
199
|
+
revisionNumber: string;
|
|
200
|
+
/**
|
|
201
|
+
* The sales-tax code for this check, determining whether it is taxable or
|
|
202
|
+
* non-taxable. If set, this overrides any sales-tax codes defined on the payee.
|
|
203
|
+
* This can be overridden on the check's individual lines.
|
|
204
|
+
*
|
|
205
|
+
* Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
|
|
206
|
+
* can also be created in QuickBooks. If QuickBooks is not set up to charge sales
|
|
207
|
+
* tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
|
|
208
|
+
* non-taxable code to all sales.
|
|
209
|
+
*/
|
|
210
|
+
salesTaxCode: Check.SalesTaxCode | null;
|
|
211
|
+
/**
|
|
212
|
+
* The date written on this check, in ISO 8601 format (YYYY-MM-DD).
|
|
213
|
+
*/
|
|
214
|
+
transactionDate: string;
|
|
215
|
+
/**
|
|
216
|
+
* The date and time when this check was last updated, in ISO 8601 format
|
|
217
|
+
* (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local
|
|
218
|
+
* timezone of the end-user's computer.
|
|
219
|
+
*/
|
|
220
|
+
updatedAt: string;
|
|
221
|
+
}
|
|
222
|
+
export declare namespace Check {
|
|
223
|
+
/**
|
|
224
|
+
* The address that is printed on the check.
|
|
225
|
+
*/
|
|
226
|
+
interface Address {
|
|
227
|
+
/**
|
|
228
|
+
* The city, district, suburb, town, or village name of the address.
|
|
229
|
+
*/
|
|
230
|
+
city: string | null;
|
|
231
|
+
/**
|
|
232
|
+
* The country name of the address.
|
|
233
|
+
*/
|
|
234
|
+
country: string | null;
|
|
235
|
+
/**
|
|
236
|
+
* The first line of the address (e.g., street, PO Box, or company name).
|
|
237
|
+
*/
|
|
238
|
+
line1: string | null;
|
|
239
|
+
/**
|
|
240
|
+
* The second line of the address, if needed (e.g., apartment, suite, unit, or
|
|
241
|
+
* building).
|
|
242
|
+
*/
|
|
243
|
+
line2: string | null;
|
|
244
|
+
/**
|
|
245
|
+
* The third line of the address, if needed.
|
|
246
|
+
*/
|
|
247
|
+
line3: string | null;
|
|
248
|
+
/**
|
|
249
|
+
* The fourth line of the address, if needed.
|
|
250
|
+
*/
|
|
251
|
+
line4: string | null;
|
|
252
|
+
/**
|
|
253
|
+
* The fifth line of the address, if needed.
|
|
254
|
+
*/
|
|
255
|
+
line5: string | null;
|
|
256
|
+
/**
|
|
257
|
+
* A note written at the bottom of the address in the form in which it appears,
|
|
258
|
+
* such as the invoice form.
|
|
259
|
+
*/
|
|
260
|
+
note: string | null;
|
|
261
|
+
/**
|
|
262
|
+
* The postal code or ZIP code of the address.
|
|
263
|
+
*/
|
|
264
|
+
postalCode: string | null;
|
|
265
|
+
/**
|
|
266
|
+
* The state, county, province, or region name of the address.
|
|
267
|
+
*/
|
|
268
|
+
state: string | null;
|
|
269
|
+
}
|
|
270
|
+
/**
|
|
271
|
+
* The bank account from which the funds are being drawn for this check; e.g.,
|
|
272
|
+
* Checking or Savings. This check will decrease the balance of this account.
|
|
273
|
+
*/
|
|
274
|
+
interface BankAccount {
|
|
275
|
+
/**
|
|
276
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
277
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
278
|
+
* types.
|
|
279
|
+
*/
|
|
280
|
+
id: string | null;
|
|
281
|
+
/**
|
|
282
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
283
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
284
|
+
* case-sensitive.
|
|
285
|
+
*/
|
|
286
|
+
fullName: string | null;
|
|
287
|
+
}
|
|
288
|
+
/**
|
|
289
|
+
* The check's currency. For built-in currencies, the name and code are standard
|
|
290
|
+
* international values. For user-defined currencies, all values are editable.
|
|
291
|
+
*/
|
|
292
|
+
interface Currency {
|
|
293
|
+
/**
|
|
294
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
295
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
296
|
+
* types.
|
|
297
|
+
*/
|
|
298
|
+
id: string | null;
|
|
299
|
+
/**
|
|
300
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
301
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
302
|
+
* case-sensitive.
|
|
303
|
+
*/
|
|
304
|
+
fullName: string | null;
|
|
305
|
+
}
|
|
306
|
+
interface CustomField {
|
|
307
|
+
/**
|
|
308
|
+
* The name of the custom field, unique for the specified `ownerId`. For public
|
|
309
|
+
* custom fields, this name is visible as a label in the QuickBooks UI.
|
|
310
|
+
*/
|
|
311
|
+
name: string;
|
|
312
|
+
/**
|
|
313
|
+
* The identifier of the owner of the custom field, which QuickBooks internally
|
|
314
|
+
* calls a "data extension". For public custom fields visible in the UI, such as
|
|
315
|
+
* those added by the QuickBooks user, this is always "0". For private custom
|
|
316
|
+
* fields that are only visible to the application that created them, this is a
|
|
317
|
+
* valid GUID identifying the owning application. Internally, Conductor always
|
|
318
|
+
* fetches all public custom fields (those with an `ownerId` of "0") for all
|
|
319
|
+
* objects.
|
|
320
|
+
*/
|
|
321
|
+
ownerId: string;
|
|
322
|
+
/**
|
|
323
|
+
* The data type of this custom field.
|
|
324
|
+
*/
|
|
325
|
+
type: 'amount_type' | 'date_time_type' | 'integer_type' | 'percent_type' | 'price_type' | 'quantity_type' | 'string_1024_type' | 'string_255_type';
|
|
326
|
+
/**
|
|
327
|
+
* The value of this custom field. The maximum length depends on the field's data
|
|
328
|
+
* type.
|
|
329
|
+
*/
|
|
330
|
+
value: string;
|
|
331
|
+
}
|
|
332
|
+
interface ExpenseLine {
|
|
333
|
+
/**
|
|
334
|
+
* The unique identifier assigned by QuickBooks to this expense line. This ID is
|
|
335
|
+
* unique across all transaction line types.
|
|
336
|
+
*/
|
|
337
|
+
id: string;
|
|
338
|
+
/**
|
|
339
|
+
* The expense account being debited (increased) for this expense line. The
|
|
340
|
+
* corresponding account being credited is usually a liability account (e.g.,
|
|
341
|
+
* Accounts-Payable) or an asset account (e.g., Cash), depending on the transaction
|
|
342
|
+
* type.
|
|
343
|
+
*/
|
|
344
|
+
account: ExpenseLine.Account | null;
|
|
345
|
+
/**
|
|
346
|
+
* The monetary amount of this expense line, represented as a decimal string.
|
|
347
|
+
*/
|
|
348
|
+
amount: string | null;
|
|
349
|
+
/**
|
|
350
|
+
* The billing status of this expense line.
|
|
351
|
+
*/
|
|
352
|
+
billingStatus: 'billable' | 'has_been_billed' | 'not_billable' | null;
|
|
353
|
+
/**
|
|
354
|
+
* The expense line's class. Classes can be used to categorize objects into
|
|
355
|
+
* meaningful segments, such as department, location, or type of work. In
|
|
356
|
+
* QuickBooks, class tracking is off by default. If a class is specified for the
|
|
357
|
+
* entire parent transaction, it is automatically applied to all expense lines
|
|
358
|
+
* unless overridden here, at the transaction line level.
|
|
359
|
+
*/
|
|
360
|
+
class: ExpenseLine.Class | null;
|
|
361
|
+
/**
|
|
362
|
+
* The custom fields for the expense line object, added as user-defined data
|
|
363
|
+
* extensions, not included in the standard QuickBooks object.
|
|
364
|
+
*/
|
|
365
|
+
customFields: Array<ExpenseLine.CustomField>;
|
|
366
|
+
/**
|
|
367
|
+
* A memo or note for this expense line.
|
|
368
|
+
*/
|
|
369
|
+
memo: string | null;
|
|
370
|
+
/**
|
|
371
|
+
* The type of object. This value is always `"qbd_expense_line"`.
|
|
372
|
+
*/
|
|
373
|
+
objectType: 'qbd_expense_line';
|
|
374
|
+
/**
|
|
375
|
+
* If `account` refers to an Accounts-Payable (A/P) account, `payee` refers to the
|
|
376
|
+
* expense's vendor (not the customer). If `account` refers to any other type of
|
|
377
|
+
* account, `payee` refers to the expense's customer (not the vendor).
|
|
378
|
+
*/
|
|
379
|
+
payee: ExpenseLine.Payee | null;
|
|
380
|
+
/**
|
|
381
|
+
* The expense line's sales representative. Sales representatives can be employees,
|
|
382
|
+
* vendors, or other names in QuickBooks.
|
|
383
|
+
*/
|
|
384
|
+
salesRepresentative: ExpenseLine.SalesRepresentative | null;
|
|
385
|
+
/**
|
|
386
|
+
* The sales-tax code for this expense line, determining whether it is taxable or
|
|
387
|
+
* non-taxable. If set, this overrides any sales-tax codes defined on the parent
|
|
388
|
+
* transaction or the associated item.
|
|
389
|
+
*
|
|
390
|
+
* Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
|
|
391
|
+
* can also be created in QuickBooks. If QuickBooks is not set up to charge sales
|
|
392
|
+
* tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
|
|
393
|
+
* non-taxable code to all sales.
|
|
394
|
+
*/
|
|
395
|
+
salesTaxCode: ExpenseLine.SalesTaxCode | null;
|
|
396
|
+
}
|
|
397
|
+
namespace ExpenseLine {
|
|
398
|
+
/**
|
|
399
|
+
* The expense account being debited (increased) for this expense line. The
|
|
400
|
+
* corresponding account being credited is usually a liability account (e.g.,
|
|
401
|
+
* Accounts-Payable) or an asset account (e.g., Cash), depending on the transaction
|
|
402
|
+
* type.
|
|
403
|
+
*/
|
|
404
|
+
interface Account {
|
|
405
|
+
/**
|
|
406
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
407
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
408
|
+
* types.
|
|
409
|
+
*/
|
|
410
|
+
id: string | null;
|
|
411
|
+
/**
|
|
412
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
413
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
414
|
+
* case-sensitive.
|
|
415
|
+
*/
|
|
416
|
+
fullName: string | null;
|
|
417
|
+
}
|
|
418
|
+
/**
|
|
419
|
+
* The expense line's class. Classes can be used to categorize objects into
|
|
420
|
+
* meaningful segments, such as department, location, or type of work. In
|
|
421
|
+
* QuickBooks, class tracking is off by default. If a class is specified for the
|
|
422
|
+
* entire parent transaction, it is automatically applied to all expense lines
|
|
423
|
+
* unless overridden here, at the transaction line level.
|
|
424
|
+
*/
|
|
425
|
+
interface Class {
|
|
426
|
+
/**
|
|
427
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
428
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
429
|
+
* types.
|
|
430
|
+
*/
|
|
431
|
+
id: string | null;
|
|
432
|
+
/**
|
|
433
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
434
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
435
|
+
* case-sensitive.
|
|
436
|
+
*/
|
|
437
|
+
fullName: string | null;
|
|
438
|
+
}
|
|
439
|
+
interface CustomField {
|
|
440
|
+
/**
|
|
441
|
+
* The name of the custom field, unique for the specified `ownerId`. For public
|
|
442
|
+
* custom fields, this name is visible as a label in the QuickBooks UI.
|
|
443
|
+
*/
|
|
444
|
+
name: string;
|
|
445
|
+
/**
|
|
446
|
+
* The identifier of the owner of the custom field, which QuickBooks internally
|
|
447
|
+
* calls a "data extension". For public custom fields visible in the UI, such as
|
|
448
|
+
* those added by the QuickBooks user, this is always "0". For private custom
|
|
449
|
+
* fields that are only visible to the application that created them, this is a
|
|
450
|
+
* valid GUID identifying the owning application. Internally, Conductor always
|
|
451
|
+
* fetches all public custom fields (those with an `ownerId` of "0") for all
|
|
452
|
+
* objects.
|
|
453
|
+
*/
|
|
454
|
+
ownerId: string;
|
|
455
|
+
/**
|
|
456
|
+
* The data type of this custom field.
|
|
457
|
+
*/
|
|
458
|
+
type: 'amount_type' | 'date_time_type' | 'integer_type' | 'percent_type' | 'price_type' | 'quantity_type' | 'string_1024_type' | 'string_255_type';
|
|
459
|
+
/**
|
|
460
|
+
* The value of this custom field. The maximum length depends on the field's data
|
|
461
|
+
* type.
|
|
462
|
+
*/
|
|
463
|
+
value: string;
|
|
464
|
+
}
|
|
465
|
+
/**
|
|
466
|
+
* If `account` refers to an Accounts-Payable (A/P) account, `payee` refers to the
|
|
467
|
+
* expense's vendor (not the customer). If `account` refers to any other type of
|
|
468
|
+
* account, `payee` refers to the expense's customer (not the vendor).
|
|
469
|
+
*/
|
|
470
|
+
interface Payee {
|
|
471
|
+
/**
|
|
472
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
473
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
474
|
+
* types.
|
|
475
|
+
*/
|
|
476
|
+
id: string | null;
|
|
477
|
+
/**
|
|
478
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
479
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
480
|
+
* case-sensitive.
|
|
481
|
+
*/
|
|
482
|
+
fullName: string | null;
|
|
483
|
+
}
|
|
484
|
+
/**
|
|
485
|
+
* The expense line's sales representative. Sales representatives can be employees,
|
|
486
|
+
* vendors, or other names in QuickBooks.
|
|
487
|
+
*/
|
|
488
|
+
interface SalesRepresentative {
|
|
489
|
+
/**
|
|
490
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
491
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
492
|
+
* types.
|
|
493
|
+
*/
|
|
494
|
+
id: string | null;
|
|
495
|
+
/**
|
|
496
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
497
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
498
|
+
* case-sensitive.
|
|
499
|
+
*/
|
|
500
|
+
fullName: string | null;
|
|
501
|
+
}
|
|
502
|
+
/**
|
|
503
|
+
* The sales-tax code for this expense line, determining whether it is taxable or
|
|
504
|
+
* non-taxable. If set, this overrides any sales-tax codes defined on the parent
|
|
505
|
+
* transaction or the associated item.
|
|
506
|
+
*
|
|
507
|
+
* Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
|
|
508
|
+
* can also be created in QuickBooks. If QuickBooks is not set up to charge sales
|
|
509
|
+
* tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
|
|
510
|
+
* non-taxable code to all sales.
|
|
511
|
+
*/
|
|
512
|
+
interface SalesTaxCode {
|
|
513
|
+
/**
|
|
514
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
515
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
516
|
+
* types.
|
|
517
|
+
*/
|
|
518
|
+
id: string | null;
|
|
519
|
+
/**
|
|
520
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
521
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
522
|
+
* case-sensitive.
|
|
523
|
+
*/
|
|
524
|
+
fullName: string | null;
|
|
525
|
+
}
|
|
526
|
+
}
|
|
527
|
+
interface ItemGroupLine {
|
|
528
|
+
/**
|
|
529
|
+
* The unique identifier assigned by QuickBooks to this item group line. This ID is
|
|
530
|
+
* unique across all transaction line types.
|
|
531
|
+
*/
|
|
532
|
+
id: string;
|
|
533
|
+
/**
|
|
534
|
+
* The custom fields for the item group line object, added as user-defined data
|
|
535
|
+
* extensions, not included in the standard QuickBooks object.
|
|
536
|
+
*/
|
|
537
|
+
customFields: Array<ItemGroupLine.CustomField>;
|
|
538
|
+
/**
|
|
539
|
+
* A description of this item group line.
|
|
540
|
+
*/
|
|
541
|
+
description: string | null;
|
|
542
|
+
/**
|
|
543
|
+
* The item group line's item group, representing a predefined set of items bundled
|
|
544
|
+
* because they are commonly purchased together or grouped for faster entry.
|
|
545
|
+
*/
|
|
546
|
+
itemGroup: ItemGroupLine.ItemGroup;
|
|
547
|
+
/**
|
|
548
|
+
* The item group line's item lines, each representing the purchase of a specific
|
|
549
|
+
* item or service.
|
|
550
|
+
*/
|
|
551
|
+
itemLines: Array<ItemGroupLine.ItemLine>;
|
|
552
|
+
/**
|
|
553
|
+
* The type of object. This value is always `"qbd_item_group_line"`.
|
|
554
|
+
*/
|
|
555
|
+
objectType: 'qbd_item_group_line';
|
|
556
|
+
/**
|
|
557
|
+
* Specifies an alternative unit-of-measure set when updating this item group
|
|
558
|
+
* line's `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to
|
|
559
|
+
* select units from a different set than the item's default unit-of-measure set,
|
|
560
|
+
* which remains unchanged on the item itself. The override applies only to this
|
|
561
|
+
* specific line. For example, you can sell an item typically measured in volume
|
|
562
|
+
* units using weight units in a specific transaction by specifying a different
|
|
563
|
+
* unit-of-measure set with this field.
|
|
564
|
+
*/
|
|
565
|
+
overrideUnitOfMeasureSet: ItemGroupLine.OverrideUnitOfMeasureSet | null;
|
|
566
|
+
/**
|
|
567
|
+
* The quantity of the item group associated with this item group line. This field
|
|
568
|
+
* cannot be cleared.
|
|
569
|
+
*
|
|
570
|
+
* **NOTE**: Do not use this field if the associated item group is a discount item
|
|
571
|
+
* group.
|
|
572
|
+
*/
|
|
573
|
+
quantity: number | null;
|
|
574
|
+
/**
|
|
575
|
+
* The total monetary amount of this item group line, equivalent to the sum of the
|
|
576
|
+
* amounts in `lines`, represented as a decimal string.
|
|
577
|
+
*/
|
|
578
|
+
totalAmount: string;
|
|
579
|
+
/**
|
|
580
|
+
* The unit-of-measure used for the `quantity` in this item group line. Must be a
|
|
581
|
+
* valid unit within the item's available units of measure.
|
|
582
|
+
*/
|
|
583
|
+
unitOfMeasure: string | null;
|
|
584
|
+
}
|
|
585
|
+
namespace ItemGroupLine {
|
|
586
|
+
interface CustomField {
|
|
587
|
+
/**
|
|
588
|
+
* The name of the custom field, unique for the specified `ownerId`. For public
|
|
589
|
+
* custom fields, this name is visible as a label in the QuickBooks UI.
|
|
590
|
+
*/
|
|
591
|
+
name: string;
|
|
592
|
+
/**
|
|
593
|
+
* The identifier of the owner of the custom field, which QuickBooks internally
|
|
594
|
+
* calls a "data extension". For public custom fields visible in the UI, such as
|
|
595
|
+
* those added by the QuickBooks user, this is always "0". For private custom
|
|
596
|
+
* fields that are only visible to the application that created them, this is a
|
|
597
|
+
* valid GUID identifying the owning application. Internally, Conductor always
|
|
598
|
+
* fetches all public custom fields (those with an `ownerId` of "0") for all
|
|
599
|
+
* objects.
|
|
600
|
+
*/
|
|
601
|
+
ownerId: string;
|
|
602
|
+
/**
|
|
603
|
+
* The data type of this custom field.
|
|
604
|
+
*/
|
|
605
|
+
type: 'amount_type' | 'date_time_type' | 'integer_type' | 'percent_type' | 'price_type' | 'quantity_type' | 'string_1024_type' | 'string_255_type';
|
|
606
|
+
/**
|
|
607
|
+
* The value of this custom field. The maximum length depends on the field's data
|
|
608
|
+
* type.
|
|
609
|
+
*/
|
|
610
|
+
value: string;
|
|
611
|
+
}
|
|
612
|
+
/**
|
|
613
|
+
* The item group line's item group, representing a predefined set of items bundled
|
|
614
|
+
* because they are commonly purchased together or grouped for faster entry.
|
|
615
|
+
*/
|
|
616
|
+
interface ItemGroup {
|
|
617
|
+
/**
|
|
618
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
619
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
620
|
+
* types.
|
|
621
|
+
*/
|
|
622
|
+
id: string | null;
|
|
623
|
+
/**
|
|
624
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
625
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
626
|
+
* case-sensitive.
|
|
627
|
+
*/
|
|
628
|
+
fullName: string | null;
|
|
629
|
+
}
|
|
630
|
+
interface ItemLine {
|
|
631
|
+
/**
|
|
632
|
+
* The unique identifier assigned by QuickBooks to this item line. This ID is
|
|
633
|
+
* unique across all transaction line types.
|
|
634
|
+
*/
|
|
635
|
+
id: string;
|
|
636
|
+
/**
|
|
637
|
+
* The monetary amount of this item line, represented as a decimal string. If both
|
|
638
|
+
* `quantity` and `cost` are specified but not `amount`, QuickBooks will use them
|
|
639
|
+
* to calculate `amount`. If `amount`, `cost`, and `quantity` are all unspecified,
|
|
640
|
+
* then QuickBooks will calculate `amount` based on a `quantity` of `1` and the
|
|
641
|
+
* suggested `cost`. This field cannot be cleared.
|
|
642
|
+
*/
|
|
643
|
+
amount: string | null;
|
|
644
|
+
/**
|
|
645
|
+
* The billing status of this item line.
|
|
646
|
+
*/
|
|
647
|
+
billingStatus: 'billable' | 'has_been_billed' | 'not_billable' | null;
|
|
648
|
+
/**
|
|
649
|
+
* The item line's class. Classes can be used to categorize objects into meaningful
|
|
650
|
+
* segments, such as department, location, or type of work. In QuickBooks, class
|
|
651
|
+
* tracking is off by default. If a class is specified for the entire parent
|
|
652
|
+
* transaction, it is automatically applied to all item lines unless overridden
|
|
653
|
+
* here, at the transaction line level.
|
|
654
|
+
*/
|
|
655
|
+
class: ItemLine.Class | null;
|
|
656
|
+
/**
|
|
657
|
+
* The cost of this item line, represented as a decimal string. If both `quantity`
|
|
658
|
+
* and `amount` are specified but not `cost`, QuickBooks will use them to calculate
|
|
659
|
+
* `cost`.
|
|
660
|
+
*/
|
|
661
|
+
cost: string | null;
|
|
662
|
+
/**
|
|
663
|
+
* The customer or customer-job associated with this item line.
|
|
664
|
+
*/
|
|
665
|
+
customer: ItemLine.Customer | null;
|
|
666
|
+
/**
|
|
667
|
+
* The custom fields for the item line object, added as user-defined data
|
|
668
|
+
* extensions, not included in the standard QuickBooks object.
|
|
669
|
+
*/
|
|
670
|
+
customFields: Array<ItemLine.CustomField>;
|
|
671
|
+
/**
|
|
672
|
+
* A description of this item line.
|
|
673
|
+
*/
|
|
674
|
+
description: string | null;
|
|
675
|
+
/**
|
|
676
|
+
* The expiration date for the serial number or lot number of the item associated
|
|
677
|
+
* with this item line, in ISO 8601 format (YYYY-MM-DD). This is particularly
|
|
678
|
+
* relevant for perishable or time-sensitive inventory items. Note that this field
|
|
679
|
+
* is only supported on QuickBooks Desktop 2023 or later.
|
|
680
|
+
*/
|
|
681
|
+
expirationDate: string | null;
|
|
682
|
+
/**
|
|
683
|
+
* The site location where inventory for the item associated with this item line is
|
|
684
|
+
* stored.
|
|
685
|
+
*/
|
|
686
|
+
inventorySite: ItemLine.InventorySite | null;
|
|
687
|
+
/**
|
|
688
|
+
* The specific location (e.g., bin or shelf) within the inventory site where the
|
|
689
|
+
* item associated with this item line is stored.
|
|
690
|
+
*/
|
|
691
|
+
inventorySiteLocation: ItemLine.InventorySiteLocation | null;
|
|
692
|
+
/**
|
|
693
|
+
* The item associated with this item line. This can refer to any good or service
|
|
694
|
+
* that the business buys or sells, including item types such as a service item,
|
|
695
|
+
* inventory item, or special calculation item like a discount item or sales-tax
|
|
696
|
+
* item.
|
|
697
|
+
*/
|
|
698
|
+
item: ItemLine.Item | null;
|
|
699
|
+
/**
|
|
700
|
+
* The lot number of the item associated with this item line. Used for tracking
|
|
701
|
+
* groups of inventory items that are purchased or manufactured together.
|
|
702
|
+
*/
|
|
703
|
+
lotNumber: string | null;
|
|
704
|
+
/**
|
|
705
|
+
* The type of object. This value is always `"qbd_item_line"`.
|
|
706
|
+
*/
|
|
707
|
+
objectType: 'qbd_item_line';
|
|
708
|
+
/**
|
|
709
|
+
* Specifies an alternative unit-of-measure set when updating this item line's
|
|
710
|
+
* `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to select
|
|
711
|
+
* units from a different set than the item's default unit-of-measure set, which
|
|
712
|
+
* remains unchanged on the item itself. The override applies only to this specific
|
|
713
|
+
* line. For example, you can sell an item typically measured in volume units using
|
|
714
|
+
* weight units in a specific transaction by specifying a different unit-of-measure
|
|
715
|
+
* set with this field.
|
|
716
|
+
*/
|
|
717
|
+
overrideUnitOfMeasureSet: ItemLine.OverrideUnitOfMeasureSet | null;
|
|
718
|
+
/**
|
|
719
|
+
* The quantity of the item associated with this item line. This field cannot be
|
|
720
|
+
* cleared.
|
|
721
|
+
*
|
|
722
|
+
* **NOTE**: Do not use this field if the associated item is a discount item.
|
|
723
|
+
*/
|
|
724
|
+
quantity: number | null;
|
|
725
|
+
/**
|
|
726
|
+
* The item line's sales representative. Sales representatives can be employees,
|
|
727
|
+
* vendors, or other names in QuickBooks.
|
|
728
|
+
*/
|
|
729
|
+
salesRepresentative: ItemLine.SalesRepresentative | null;
|
|
730
|
+
/**
|
|
731
|
+
* The sales-tax code for this item line, determining whether it is taxable or
|
|
732
|
+
* non-taxable. If set, this overrides any sales-tax codes defined on the parent
|
|
733
|
+
* transaction or the associated item.
|
|
734
|
+
*
|
|
735
|
+
* Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
|
|
736
|
+
* can also be created in QuickBooks. If QuickBooks is not set up to charge sales
|
|
737
|
+
* tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
|
|
738
|
+
* non-taxable code to all sales.
|
|
739
|
+
*/
|
|
740
|
+
salesTaxCode: ItemLine.SalesTaxCode | null;
|
|
741
|
+
/**
|
|
742
|
+
* The serial number of the item associated with this item line. This is used for
|
|
743
|
+
* tracking individual units of serialized inventory items.
|
|
744
|
+
*/
|
|
745
|
+
serialNumber: string | null;
|
|
746
|
+
/**
|
|
747
|
+
* The unit-of-measure used for the `quantity` in this item line. Must be a valid
|
|
748
|
+
* unit within the item's available units of measure.
|
|
749
|
+
*/
|
|
750
|
+
unitOfMeasure: string | null;
|
|
751
|
+
}
|
|
752
|
+
namespace ItemLine {
|
|
753
|
+
/**
|
|
754
|
+
* The item line's class. Classes can be used to categorize objects into meaningful
|
|
755
|
+
* segments, such as department, location, or type of work. In QuickBooks, class
|
|
756
|
+
* tracking is off by default. If a class is specified for the entire parent
|
|
757
|
+
* transaction, it is automatically applied to all item lines unless overridden
|
|
758
|
+
* here, at the transaction line level.
|
|
759
|
+
*/
|
|
760
|
+
interface Class {
|
|
761
|
+
/**
|
|
762
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
763
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
764
|
+
* types.
|
|
765
|
+
*/
|
|
766
|
+
id: string | null;
|
|
767
|
+
/**
|
|
768
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
769
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
770
|
+
* case-sensitive.
|
|
771
|
+
*/
|
|
772
|
+
fullName: string | null;
|
|
773
|
+
}
|
|
774
|
+
/**
|
|
775
|
+
* The customer or customer-job associated with this item line.
|
|
776
|
+
*/
|
|
777
|
+
interface Customer {
|
|
778
|
+
/**
|
|
779
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
780
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
781
|
+
* types.
|
|
782
|
+
*/
|
|
783
|
+
id: string | null;
|
|
784
|
+
/**
|
|
785
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
786
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
787
|
+
* case-sensitive.
|
|
788
|
+
*/
|
|
789
|
+
fullName: string | null;
|
|
790
|
+
}
|
|
791
|
+
interface CustomField {
|
|
792
|
+
/**
|
|
793
|
+
* The name of the custom field, unique for the specified `ownerId`. For public
|
|
794
|
+
* custom fields, this name is visible as a label in the QuickBooks UI.
|
|
795
|
+
*/
|
|
796
|
+
name: string;
|
|
797
|
+
/**
|
|
798
|
+
* The identifier of the owner of the custom field, which QuickBooks internally
|
|
799
|
+
* calls a "data extension". For public custom fields visible in the UI, such as
|
|
800
|
+
* those added by the QuickBooks user, this is always "0". For private custom
|
|
801
|
+
* fields that are only visible to the application that created them, this is a
|
|
802
|
+
* valid GUID identifying the owning application. Internally, Conductor always
|
|
803
|
+
* fetches all public custom fields (those with an `ownerId` of "0") for all
|
|
804
|
+
* objects.
|
|
805
|
+
*/
|
|
806
|
+
ownerId: string;
|
|
807
|
+
/**
|
|
808
|
+
* The data type of this custom field.
|
|
809
|
+
*/
|
|
810
|
+
type: 'amount_type' | 'date_time_type' | 'integer_type' | 'percent_type' | 'price_type' | 'quantity_type' | 'string_1024_type' | 'string_255_type';
|
|
811
|
+
/**
|
|
812
|
+
* The value of this custom field. The maximum length depends on the field's data
|
|
813
|
+
* type.
|
|
814
|
+
*/
|
|
815
|
+
value: string;
|
|
816
|
+
}
|
|
817
|
+
/**
|
|
818
|
+
* The site location where inventory for the item associated with this item line is
|
|
819
|
+
* stored.
|
|
820
|
+
*/
|
|
821
|
+
interface InventorySite {
|
|
822
|
+
/**
|
|
823
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
824
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
825
|
+
* types.
|
|
826
|
+
*/
|
|
827
|
+
id: string | null;
|
|
828
|
+
/**
|
|
829
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
830
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
831
|
+
* case-sensitive.
|
|
832
|
+
*/
|
|
833
|
+
fullName: string | null;
|
|
834
|
+
}
|
|
835
|
+
/**
|
|
836
|
+
* The specific location (e.g., bin or shelf) within the inventory site where the
|
|
837
|
+
* item associated with this item line is stored.
|
|
838
|
+
*/
|
|
839
|
+
interface InventorySiteLocation {
|
|
840
|
+
/**
|
|
841
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
842
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
843
|
+
* types.
|
|
844
|
+
*/
|
|
845
|
+
id: string | null;
|
|
846
|
+
/**
|
|
847
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
848
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
849
|
+
* case-sensitive.
|
|
850
|
+
*/
|
|
851
|
+
fullName: string | null;
|
|
852
|
+
}
|
|
853
|
+
/**
|
|
854
|
+
* The item associated with this item line. This can refer to any good or service
|
|
855
|
+
* that the business buys or sells, including item types such as a service item,
|
|
856
|
+
* inventory item, or special calculation item like a discount item or sales-tax
|
|
857
|
+
* item.
|
|
858
|
+
*/
|
|
859
|
+
interface Item {
|
|
860
|
+
/**
|
|
861
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
862
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
863
|
+
* types.
|
|
864
|
+
*/
|
|
865
|
+
id: string | null;
|
|
866
|
+
/**
|
|
867
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
868
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
869
|
+
* case-sensitive.
|
|
870
|
+
*/
|
|
871
|
+
fullName: string | null;
|
|
872
|
+
}
|
|
873
|
+
/**
|
|
874
|
+
* Specifies an alternative unit-of-measure set when updating this item line's
|
|
875
|
+
* `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to select
|
|
876
|
+
* units from a different set than the item's default unit-of-measure set, which
|
|
877
|
+
* remains unchanged on the item itself. The override applies only to this specific
|
|
878
|
+
* line. For example, you can sell an item typically measured in volume units using
|
|
879
|
+
* weight units in a specific transaction by specifying a different unit-of-measure
|
|
880
|
+
* set with this field.
|
|
881
|
+
*/
|
|
882
|
+
interface OverrideUnitOfMeasureSet {
|
|
883
|
+
/**
|
|
884
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
885
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
886
|
+
* types.
|
|
887
|
+
*/
|
|
888
|
+
id: string | null;
|
|
889
|
+
/**
|
|
890
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
891
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
892
|
+
* case-sensitive.
|
|
893
|
+
*/
|
|
894
|
+
fullName: string | null;
|
|
895
|
+
}
|
|
896
|
+
/**
|
|
897
|
+
* The item line's sales representative. Sales representatives can be employees,
|
|
898
|
+
* vendors, or other names in QuickBooks.
|
|
899
|
+
*/
|
|
900
|
+
interface SalesRepresentative {
|
|
901
|
+
/**
|
|
902
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
903
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
904
|
+
* types.
|
|
905
|
+
*/
|
|
906
|
+
id: string | null;
|
|
907
|
+
/**
|
|
908
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
909
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
910
|
+
* case-sensitive.
|
|
911
|
+
*/
|
|
912
|
+
fullName: string | null;
|
|
913
|
+
}
|
|
914
|
+
/**
|
|
915
|
+
* The sales-tax code for this item line, determining whether it is taxable or
|
|
916
|
+
* non-taxable. If set, this overrides any sales-tax codes defined on the parent
|
|
917
|
+
* transaction or the associated item.
|
|
918
|
+
*
|
|
919
|
+
* Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
|
|
920
|
+
* can also be created in QuickBooks. If QuickBooks is not set up to charge sales
|
|
921
|
+
* tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
|
|
922
|
+
* non-taxable code to all sales.
|
|
923
|
+
*/
|
|
924
|
+
interface SalesTaxCode {
|
|
925
|
+
/**
|
|
926
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
927
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
928
|
+
* types.
|
|
929
|
+
*/
|
|
930
|
+
id: string | null;
|
|
931
|
+
/**
|
|
932
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
933
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
934
|
+
* case-sensitive.
|
|
935
|
+
*/
|
|
936
|
+
fullName: string | null;
|
|
937
|
+
}
|
|
938
|
+
}
|
|
939
|
+
/**
|
|
940
|
+
* Specifies an alternative unit-of-measure set when updating this item group
|
|
941
|
+
* line's `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to
|
|
942
|
+
* select units from a different set than the item's default unit-of-measure set,
|
|
943
|
+
* which remains unchanged on the item itself. The override applies only to this
|
|
944
|
+
* specific line. For example, you can sell an item typically measured in volume
|
|
945
|
+
* units using weight units in a specific transaction by specifying a different
|
|
946
|
+
* unit-of-measure set with this field.
|
|
947
|
+
*/
|
|
948
|
+
interface OverrideUnitOfMeasureSet {
|
|
949
|
+
/**
|
|
950
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
951
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
952
|
+
* types.
|
|
953
|
+
*/
|
|
954
|
+
id: string | null;
|
|
955
|
+
/**
|
|
956
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
957
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
958
|
+
* case-sensitive.
|
|
959
|
+
*/
|
|
960
|
+
fullName: string | null;
|
|
961
|
+
}
|
|
962
|
+
}
|
|
963
|
+
interface ItemLine {
|
|
964
|
+
/**
|
|
965
|
+
* The unique identifier assigned by QuickBooks to this item line. This ID is
|
|
966
|
+
* unique across all transaction line types.
|
|
967
|
+
*/
|
|
968
|
+
id: string;
|
|
969
|
+
/**
|
|
970
|
+
* The monetary amount of this item line, represented as a decimal string. If both
|
|
971
|
+
* `quantity` and `cost` are specified but not `amount`, QuickBooks will use them
|
|
972
|
+
* to calculate `amount`. If `amount`, `cost`, and `quantity` are all unspecified,
|
|
973
|
+
* then QuickBooks will calculate `amount` based on a `quantity` of `1` and the
|
|
974
|
+
* suggested `cost`. This field cannot be cleared.
|
|
975
|
+
*/
|
|
976
|
+
amount: string | null;
|
|
977
|
+
/**
|
|
978
|
+
* The billing status of this item line.
|
|
979
|
+
*/
|
|
980
|
+
billingStatus: 'billable' | 'has_been_billed' | 'not_billable' | null;
|
|
981
|
+
/**
|
|
982
|
+
* The item line's class. Classes can be used to categorize objects into meaningful
|
|
983
|
+
* segments, such as department, location, or type of work. In QuickBooks, class
|
|
984
|
+
* tracking is off by default. If a class is specified for the entire parent
|
|
985
|
+
* transaction, it is automatically applied to all item lines unless overridden
|
|
986
|
+
* here, at the transaction line level.
|
|
987
|
+
*/
|
|
988
|
+
class: ItemLine.Class | null;
|
|
989
|
+
/**
|
|
990
|
+
* The cost of this item line, represented as a decimal string. If both `quantity`
|
|
991
|
+
* and `amount` are specified but not `cost`, QuickBooks will use them to calculate
|
|
992
|
+
* `cost`.
|
|
993
|
+
*/
|
|
994
|
+
cost: string | null;
|
|
995
|
+
/**
|
|
996
|
+
* The customer or customer-job associated with this item line.
|
|
997
|
+
*/
|
|
998
|
+
customer: ItemLine.Customer | null;
|
|
999
|
+
/**
|
|
1000
|
+
* The custom fields for the item line object, added as user-defined data
|
|
1001
|
+
* extensions, not included in the standard QuickBooks object.
|
|
1002
|
+
*/
|
|
1003
|
+
customFields: Array<ItemLine.CustomField>;
|
|
1004
|
+
/**
|
|
1005
|
+
* A description of this item line.
|
|
1006
|
+
*/
|
|
1007
|
+
description: string | null;
|
|
1008
|
+
/**
|
|
1009
|
+
* The expiration date for the serial number or lot number of the item associated
|
|
1010
|
+
* with this item line, in ISO 8601 format (YYYY-MM-DD). This is particularly
|
|
1011
|
+
* relevant for perishable or time-sensitive inventory items. Note that this field
|
|
1012
|
+
* is only supported on QuickBooks Desktop 2023 or later.
|
|
1013
|
+
*/
|
|
1014
|
+
expirationDate: string | null;
|
|
1015
|
+
/**
|
|
1016
|
+
* The site location where inventory for the item associated with this item line is
|
|
1017
|
+
* stored.
|
|
1018
|
+
*/
|
|
1019
|
+
inventorySite: ItemLine.InventorySite | null;
|
|
1020
|
+
/**
|
|
1021
|
+
* The specific location (e.g., bin or shelf) within the inventory site where the
|
|
1022
|
+
* item associated with this item line is stored.
|
|
1023
|
+
*/
|
|
1024
|
+
inventorySiteLocation: ItemLine.InventorySiteLocation | null;
|
|
1025
|
+
/**
|
|
1026
|
+
* The item associated with this item line. This can refer to any good or service
|
|
1027
|
+
* that the business buys or sells, including item types such as a service item,
|
|
1028
|
+
* inventory item, or special calculation item like a discount item or sales-tax
|
|
1029
|
+
* item.
|
|
1030
|
+
*/
|
|
1031
|
+
item: ItemLine.Item | null;
|
|
1032
|
+
/**
|
|
1033
|
+
* The lot number of the item associated with this item line. Used for tracking
|
|
1034
|
+
* groups of inventory items that are purchased or manufactured together.
|
|
1035
|
+
*/
|
|
1036
|
+
lotNumber: string | null;
|
|
1037
|
+
/**
|
|
1038
|
+
* The type of object. This value is always `"qbd_item_line"`.
|
|
1039
|
+
*/
|
|
1040
|
+
objectType: 'qbd_item_line';
|
|
1041
|
+
/**
|
|
1042
|
+
* Specifies an alternative unit-of-measure set when updating this item line's
|
|
1043
|
+
* `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to select
|
|
1044
|
+
* units from a different set than the item's default unit-of-measure set, which
|
|
1045
|
+
* remains unchanged on the item itself. The override applies only to this specific
|
|
1046
|
+
* line. For example, you can sell an item typically measured in volume units using
|
|
1047
|
+
* weight units in a specific transaction by specifying a different unit-of-measure
|
|
1048
|
+
* set with this field.
|
|
1049
|
+
*/
|
|
1050
|
+
overrideUnitOfMeasureSet: ItemLine.OverrideUnitOfMeasureSet | null;
|
|
1051
|
+
/**
|
|
1052
|
+
* The quantity of the item associated with this item line. This field cannot be
|
|
1053
|
+
* cleared.
|
|
1054
|
+
*
|
|
1055
|
+
* **NOTE**: Do not use this field if the associated item is a discount item.
|
|
1056
|
+
*/
|
|
1057
|
+
quantity: number | null;
|
|
1058
|
+
/**
|
|
1059
|
+
* The item line's sales representative. Sales representatives can be employees,
|
|
1060
|
+
* vendors, or other names in QuickBooks.
|
|
1061
|
+
*/
|
|
1062
|
+
salesRepresentative: ItemLine.SalesRepresentative | null;
|
|
1063
|
+
/**
|
|
1064
|
+
* The sales-tax code for this item line, determining whether it is taxable or
|
|
1065
|
+
* non-taxable. If set, this overrides any sales-tax codes defined on the parent
|
|
1066
|
+
* transaction or the associated item.
|
|
1067
|
+
*
|
|
1068
|
+
* Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
|
|
1069
|
+
* can also be created in QuickBooks. If QuickBooks is not set up to charge sales
|
|
1070
|
+
* tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
|
|
1071
|
+
* non-taxable code to all sales.
|
|
1072
|
+
*/
|
|
1073
|
+
salesTaxCode: ItemLine.SalesTaxCode | null;
|
|
1074
|
+
/**
|
|
1075
|
+
* The serial number of the item associated with this item line. This is used for
|
|
1076
|
+
* tracking individual units of serialized inventory items.
|
|
1077
|
+
*/
|
|
1078
|
+
serialNumber: string | null;
|
|
1079
|
+
/**
|
|
1080
|
+
* The unit-of-measure used for the `quantity` in this item line. Must be a valid
|
|
1081
|
+
* unit within the item's available units of measure.
|
|
1082
|
+
*/
|
|
1083
|
+
unitOfMeasure: string | null;
|
|
1084
|
+
}
|
|
1085
|
+
namespace ItemLine {
|
|
1086
|
+
/**
|
|
1087
|
+
* The item line's class. Classes can be used to categorize objects into meaningful
|
|
1088
|
+
* segments, such as department, location, or type of work. In QuickBooks, class
|
|
1089
|
+
* tracking is off by default. If a class is specified for the entire parent
|
|
1090
|
+
* transaction, it is automatically applied to all item lines unless overridden
|
|
1091
|
+
* here, at the transaction line level.
|
|
1092
|
+
*/
|
|
1093
|
+
interface Class {
|
|
1094
|
+
/**
|
|
1095
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
1096
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
1097
|
+
* types.
|
|
1098
|
+
*/
|
|
1099
|
+
id: string | null;
|
|
1100
|
+
/**
|
|
1101
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
1102
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
1103
|
+
* case-sensitive.
|
|
1104
|
+
*/
|
|
1105
|
+
fullName: string | null;
|
|
1106
|
+
}
|
|
1107
|
+
/**
|
|
1108
|
+
* The customer or customer-job associated with this item line.
|
|
1109
|
+
*/
|
|
1110
|
+
interface Customer {
|
|
1111
|
+
/**
|
|
1112
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
1113
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
1114
|
+
* types.
|
|
1115
|
+
*/
|
|
1116
|
+
id: string | null;
|
|
1117
|
+
/**
|
|
1118
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
1119
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
1120
|
+
* case-sensitive.
|
|
1121
|
+
*/
|
|
1122
|
+
fullName: string | null;
|
|
1123
|
+
}
|
|
1124
|
+
interface CustomField {
|
|
1125
|
+
/**
|
|
1126
|
+
* The name of the custom field, unique for the specified `ownerId`. For public
|
|
1127
|
+
* custom fields, this name is visible as a label in the QuickBooks UI.
|
|
1128
|
+
*/
|
|
1129
|
+
name: string;
|
|
1130
|
+
/**
|
|
1131
|
+
* The identifier of the owner of the custom field, which QuickBooks internally
|
|
1132
|
+
* calls a "data extension". For public custom fields visible in the UI, such as
|
|
1133
|
+
* those added by the QuickBooks user, this is always "0". For private custom
|
|
1134
|
+
* fields that are only visible to the application that created them, this is a
|
|
1135
|
+
* valid GUID identifying the owning application. Internally, Conductor always
|
|
1136
|
+
* fetches all public custom fields (those with an `ownerId` of "0") for all
|
|
1137
|
+
* objects.
|
|
1138
|
+
*/
|
|
1139
|
+
ownerId: string;
|
|
1140
|
+
/**
|
|
1141
|
+
* The data type of this custom field.
|
|
1142
|
+
*/
|
|
1143
|
+
type: 'amount_type' | 'date_time_type' | 'integer_type' | 'percent_type' | 'price_type' | 'quantity_type' | 'string_1024_type' | 'string_255_type';
|
|
1144
|
+
/**
|
|
1145
|
+
* The value of this custom field. The maximum length depends on the field's data
|
|
1146
|
+
* type.
|
|
1147
|
+
*/
|
|
1148
|
+
value: string;
|
|
1149
|
+
}
|
|
1150
|
+
/**
|
|
1151
|
+
* The site location where inventory for the item associated with this item line is
|
|
1152
|
+
* stored.
|
|
1153
|
+
*/
|
|
1154
|
+
interface InventorySite {
|
|
1155
|
+
/**
|
|
1156
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
1157
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
1158
|
+
* types.
|
|
1159
|
+
*/
|
|
1160
|
+
id: string | null;
|
|
1161
|
+
/**
|
|
1162
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
1163
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
1164
|
+
* case-sensitive.
|
|
1165
|
+
*/
|
|
1166
|
+
fullName: string | null;
|
|
1167
|
+
}
|
|
1168
|
+
/**
|
|
1169
|
+
* The specific location (e.g., bin or shelf) within the inventory site where the
|
|
1170
|
+
* item associated with this item line is stored.
|
|
1171
|
+
*/
|
|
1172
|
+
interface InventorySiteLocation {
|
|
1173
|
+
/**
|
|
1174
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
1175
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
1176
|
+
* types.
|
|
1177
|
+
*/
|
|
1178
|
+
id: string | null;
|
|
1179
|
+
/**
|
|
1180
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
1181
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
1182
|
+
* case-sensitive.
|
|
1183
|
+
*/
|
|
1184
|
+
fullName: string | null;
|
|
1185
|
+
}
|
|
1186
|
+
/**
|
|
1187
|
+
* The item associated with this item line. This can refer to any good or service
|
|
1188
|
+
* that the business buys or sells, including item types such as a service item,
|
|
1189
|
+
* inventory item, or special calculation item like a discount item or sales-tax
|
|
1190
|
+
* item.
|
|
1191
|
+
*/
|
|
1192
|
+
interface Item {
|
|
1193
|
+
/**
|
|
1194
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
1195
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
1196
|
+
* types.
|
|
1197
|
+
*/
|
|
1198
|
+
id: string | null;
|
|
1199
|
+
/**
|
|
1200
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
1201
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
1202
|
+
* case-sensitive.
|
|
1203
|
+
*/
|
|
1204
|
+
fullName: string | null;
|
|
1205
|
+
}
|
|
1206
|
+
/**
|
|
1207
|
+
* Specifies an alternative unit-of-measure set when updating this item line's
|
|
1208
|
+
* `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to select
|
|
1209
|
+
* units from a different set than the item's default unit-of-measure set, which
|
|
1210
|
+
* remains unchanged on the item itself. The override applies only to this specific
|
|
1211
|
+
* line. For example, you can sell an item typically measured in volume units using
|
|
1212
|
+
* weight units in a specific transaction by specifying a different unit-of-measure
|
|
1213
|
+
* set with this field.
|
|
1214
|
+
*/
|
|
1215
|
+
interface OverrideUnitOfMeasureSet {
|
|
1216
|
+
/**
|
|
1217
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
1218
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
1219
|
+
* types.
|
|
1220
|
+
*/
|
|
1221
|
+
id: string | null;
|
|
1222
|
+
/**
|
|
1223
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
1224
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
1225
|
+
* case-sensitive.
|
|
1226
|
+
*/
|
|
1227
|
+
fullName: string | null;
|
|
1228
|
+
}
|
|
1229
|
+
/**
|
|
1230
|
+
* The item line's sales representative. Sales representatives can be employees,
|
|
1231
|
+
* vendors, or other names in QuickBooks.
|
|
1232
|
+
*/
|
|
1233
|
+
interface SalesRepresentative {
|
|
1234
|
+
/**
|
|
1235
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
1236
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
1237
|
+
* types.
|
|
1238
|
+
*/
|
|
1239
|
+
id: string | null;
|
|
1240
|
+
/**
|
|
1241
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
1242
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
1243
|
+
* case-sensitive.
|
|
1244
|
+
*/
|
|
1245
|
+
fullName: string | null;
|
|
1246
|
+
}
|
|
1247
|
+
/**
|
|
1248
|
+
* The sales-tax code for this item line, determining whether it is taxable or
|
|
1249
|
+
* non-taxable. If set, this overrides any sales-tax codes defined on the parent
|
|
1250
|
+
* transaction or the associated item.
|
|
1251
|
+
*
|
|
1252
|
+
* Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
|
|
1253
|
+
* can also be created in QuickBooks. If QuickBooks is not set up to charge sales
|
|
1254
|
+
* tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
|
|
1255
|
+
* non-taxable code to all sales.
|
|
1256
|
+
*/
|
|
1257
|
+
interface SalesTaxCode {
|
|
1258
|
+
/**
|
|
1259
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
1260
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
1261
|
+
* types.
|
|
1262
|
+
*/
|
|
1263
|
+
id: string | null;
|
|
1264
|
+
/**
|
|
1265
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
1266
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
1267
|
+
* case-sensitive.
|
|
1268
|
+
*/
|
|
1269
|
+
fullName: string | null;
|
|
1270
|
+
}
|
|
1271
|
+
}
|
|
1272
|
+
interface LinkedTransaction {
|
|
1273
|
+
/**
|
|
1274
|
+
* The unique identifier assigned by QuickBooks to this linked transaction. This ID
|
|
1275
|
+
* is unique across all transaction types.
|
|
1276
|
+
*/
|
|
1277
|
+
id: string;
|
|
1278
|
+
/**
|
|
1279
|
+
* The monetary amount of this linked transaction, represented as a decimal string.
|
|
1280
|
+
*/
|
|
1281
|
+
amount: string | null;
|
|
1282
|
+
/**
|
|
1283
|
+
* Indicates the nature of the link between the transactions: `amount` denotes an
|
|
1284
|
+
* amount-based link (e.g., an invoice linked to a payment), and `quantity` denotes
|
|
1285
|
+
* a quantity-based link (e.g., an invoice created from a sales order based on the
|
|
1286
|
+
* quantity of items received).
|
|
1287
|
+
*/
|
|
1288
|
+
linkType: 'amount' | 'quantity' | null;
|
|
1289
|
+
/**
|
|
1290
|
+
* The type of object. This value is always `"qbd_linked_transaction"`.
|
|
1291
|
+
*/
|
|
1292
|
+
objectType: 'qbd_linked_transaction';
|
|
1293
|
+
/**
|
|
1294
|
+
* The case-sensitive user-defined reference number for this linked transaction,
|
|
1295
|
+
* which can be used to identify the transaction in QuickBooks. This value is not
|
|
1296
|
+
* required to be unique and can be arbitrarily changed by the QuickBooks user.
|
|
1297
|
+
*/
|
|
1298
|
+
refNumber: string | null;
|
|
1299
|
+
/**
|
|
1300
|
+
* The date of this linked transaction, in ISO 8601 format (YYYY-MM-DD).
|
|
1301
|
+
*/
|
|
1302
|
+
transactionDate: string;
|
|
1303
|
+
/**
|
|
1304
|
+
* The type of transaction for this linked transaction.
|
|
1305
|
+
*/
|
|
1306
|
+
transactionType: 'ar_refund_credit_card' | 'bill' | 'bill_payment_check' | 'bill_payment_credit_card' | 'build_assembly' | 'charge' | 'check' | 'credit_card_charge' | 'credit_card_credit' | 'credit_memo' | 'deposit' | 'estimate' | 'inventory_adjustment' | 'invoice' | 'item_receipt' | 'journal_entry' | 'liability_adjustment' | 'paycheck' | 'payroll_liability_check' | 'purchase_order' | 'receive_payment' | 'sales_order' | 'sales_receipt' | 'sales_tax_payment_check' | 'transfer' | 'vendor_credit' | 'ytd_adjustment' | 'unknown';
|
|
1307
|
+
}
|
|
1308
|
+
/**
|
|
1309
|
+
* The person or company who will receive this check.
|
|
1310
|
+
*/
|
|
1311
|
+
interface Payee {
|
|
1312
|
+
/**
|
|
1313
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
1314
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
1315
|
+
* types.
|
|
1316
|
+
*/
|
|
1317
|
+
id: string | null;
|
|
1318
|
+
/**
|
|
1319
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
1320
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
1321
|
+
* case-sensitive.
|
|
1322
|
+
*/
|
|
1323
|
+
fullName: string | null;
|
|
1324
|
+
}
|
|
1325
|
+
/**
|
|
1326
|
+
* The sales-tax code for this check, determining whether it is taxable or
|
|
1327
|
+
* non-taxable. If set, this overrides any sales-tax codes defined on the payee.
|
|
1328
|
+
* This can be overridden on the check's individual lines.
|
|
1329
|
+
*
|
|
1330
|
+
* Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
|
|
1331
|
+
* can also be created in QuickBooks. If QuickBooks is not set up to charge sales
|
|
1332
|
+
* tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
|
|
1333
|
+
* non-taxable code to all sales.
|
|
1334
|
+
*/
|
|
1335
|
+
interface SalesTaxCode {
|
|
1336
|
+
/**
|
|
1337
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
1338
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
1339
|
+
* types.
|
|
1340
|
+
*/
|
|
1341
|
+
id: string | null;
|
|
1342
|
+
/**
|
|
1343
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
1344
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
1345
|
+
* case-sensitive.
|
|
1346
|
+
*/
|
|
1347
|
+
fullName: string | null;
|
|
1348
|
+
}
|
|
1349
|
+
}
|
|
1350
|
+
export interface CheckDeleteResponse {
|
|
1351
|
+
/**
|
|
1352
|
+
* The QuickBooks-assigned unique identifier of the deleted check.
|
|
1353
|
+
*/
|
|
1354
|
+
id: string;
|
|
1355
|
+
/**
|
|
1356
|
+
* Indicates whether the check was deleted.
|
|
1357
|
+
*/
|
|
1358
|
+
deleted: boolean;
|
|
1359
|
+
/**
|
|
1360
|
+
* The type of object. This value is always `"qbd_check"`.
|
|
1361
|
+
*/
|
|
1362
|
+
objectType: 'qbd_check';
|
|
1363
|
+
/**
|
|
1364
|
+
* The case-sensitive user-defined reference number of the deleted check.
|
|
1365
|
+
*/
|
|
1366
|
+
refNumber: string | null;
|
|
1367
|
+
}
|
|
1368
|
+
export interface CheckCreateParams {
|
|
1369
|
+
/**
|
|
1370
|
+
* Body param: The bank account from which the funds are being drawn for this
|
|
1371
|
+
* check; e.g., Checking or Savings. This check will decrease the balance of this
|
|
1372
|
+
* account.
|
|
1373
|
+
*/
|
|
1374
|
+
bankAccountId: string;
|
|
1375
|
+
/**
|
|
1376
|
+
* Body param: The date written on this check, in ISO 8601 format (YYYY-MM-DD).
|
|
1377
|
+
*/
|
|
1378
|
+
transactionDate: string;
|
|
1379
|
+
/**
|
|
1380
|
+
* Header param: The ID of the End-User to receive this request.
|
|
1381
|
+
*/
|
|
1382
|
+
conductorEndUserId: string;
|
|
1383
|
+
/**
|
|
1384
|
+
* Body param: The address that is printed on the check.
|
|
1385
|
+
*/
|
|
1386
|
+
address?: CheckCreateParams.Address;
|
|
1387
|
+
/**
|
|
1388
|
+
* Body param: Transactions to be paid by this check. This will create a link
|
|
1389
|
+
* between this check and the specified transactions.
|
|
1390
|
+
*
|
|
1391
|
+
* **IMPORTANT**: By default, QuickBooks will not return any information about the
|
|
1392
|
+
* linked transactions in this endpoint's response even when this request is
|
|
1393
|
+
* successful. To see the transactions linked via this field, refetch the check and
|
|
1394
|
+
* check the `linkedTransactions` response field. If fetching a list of checks, you
|
|
1395
|
+
* must also specify the parameter `includeLinkedTransactions=true` to see the
|
|
1396
|
+
* `linkedTransactions` response field.
|
|
1397
|
+
*/
|
|
1398
|
+
applyToTransactions?: Array<CheckCreateParams.ApplyToTransaction>;
|
|
1399
|
+
/**
|
|
1400
|
+
* Body param: The market exchange rate between this check's currency and the home
|
|
1401
|
+
* currency in QuickBooks at the time of this transaction. Represented as a decimal
|
|
1402
|
+
* value (e.g., 1.2345 for 1 EUR = 1.2345 USD if USD is the home currency).
|
|
1403
|
+
*/
|
|
1404
|
+
exchangeRate?: number;
|
|
1405
|
+
/**
|
|
1406
|
+
* Body param: The check's expense lines, each representing one line in this
|
|
1407
|
+
* expense.
|
|
1408
|
+
*/
|
|
1409
|
+
expenseLines?: Array<CheckCreateParams.ExpenseLine>;
|
|
1410
|
+
/**
|
|
1411
|
+
* Body param: A globally unique identifier (GUID) you, the developer, can provide
|
|
1412
|
+
* for tracking this object in your external system. This field is immutable and
|
|
1413
|
+
* can only be set during object creation.
|
|
1414
|
+
*
|
|
1415
|
+
* **IMPORTANT**: This field must be formatted as a valid GUID; otherwise,
|
|
1416
|
+
* QuickBooks will return an error.
|
|
1417
|
+
*/
|
|
1418
|
+
externalId?: string;
|
|
1419
|
+
/**
|
|
1420
|
+
* Body param: Indicates whether this check is included in the queue of documents
|
|
1421
|
+
* for QuickBooks to print.
|
|
1422
|
+
*/
|
|
1423
|
+
isQueuedForPrint?: boolean;
|
|
1424
|
+
/**
|
|
1425
|
+
* Body param: The check's item group lines, each representing a predefined set of
|
|
1426
|
+
* items bundled together because they are commonly purchased together or grouped
|
|
1427
|
+
* for faster entry.
|
|
1428
|
+
*/
|
|
1429
|
+
itemGroupLines?: Array<CheckCreateParams.ItemGroupLine>;
|
|
1430
|
+
/**
|
|
1431
|
+
* Body param: The check's item lines, each representing the purchase of a specific
|
|
1432
|
+
* item or service.
|
|
1433
|
+
*/
|
|
1434
|
+
itemLines?: Array<CheckCreateParams.ItemLine>;
|
|
1435
|
+
/**
|
|
1436
|
+
* Body param: The memo that is printed on this check.
|
|
1437
|
+
*/
|
|
1438
|
+
memo?: string;
|
|
1439
|
+
/**
|
|
1440
|
+
* Body param: The person or company who will receive this check.
|
|
1441
|
+
*/
|
|
1442
|
+
payeeId?: string;
|
|
1443
|
+
/**
|
|
1444
|
+
* Body param: The case-sensitive user-defined reference number for this check,
|
|
1445
|
+
* which can be used to identify the transaction in QuickBooks. This value is not
|
|
1446
|
+
* required to be unique and can be arbitrarily changed by the QuickBooks user.
|
|
1447
|
+
* When left blank in this create request, this field will be left blank in
|
|
1448
|
+
* QuickBooks (i.e., it does _not_ auto-increment).
|
|
1449
|
+
*
|
|
1450
|
+
* **IMPORTANT**: For checks, this field is the check number.
|
|
1451
|
+
*/
|
|
1452
|
+
refNumber?: string;
|
|
1453
|
+
/**
|
|
1454
|
+
* Body param: The sales-tax code for this check, determining whether it is taxable
|
|
1455
|
+
* or non-taxable. If set, this overrides any sales-tax codes defined on the payee.
|
|
1456
|
+
* This can be overridden on the check's individual lines.
|
|
1457
|
+
*
|
|
1458
|
+
* Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
|
|
1459
|
+
* can also be created in QuickBooks. If QuickBooks is not set up to charge sales
|
|
1460
|
+
* tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
|
|
1461
|
+
* non-taxable code to all sales.
|
|
1462
|
+
*/
|
|
1463
|
+
salesTaxCodeId?: string;
|
|
1464
|
+
}
|
|
1465
|
+
export declare namespace CheckCreateParams {
|
|
1466
|
+
/**
|
|
1467
|
+
* The address that is printed on the check.
|
|
1468
|
+
*/
|
|
1469
|
+
interface Address {
|
|
1470
|
+
/**
|
|
1471
|
+
* The city, district, suburb, town, or village name of the address.
|
|
1472
|
+
*
|
|
1473
|
+
* Maximum length: 31 characters.
|
|
1474
|
+
*/
|
|
1475
|
+
city?: string;
|
|
1476
|
+
/**
|
|
1477
|
+
* The country name of the address.
|
|
1478
|
+
*/
|
|
1479
|
+
country?: string;
|
|
1480
|
+
/**
|
|
1481
|
+
* The first line of the address (e.g., street, PO Box, or company name).
|
|
1482
|
+
*
|
|
1483
|
+
* Maximum length: 41 characters.
|
|
1484
|
+
*/
|
|
1485
|
+
line1?: string;
|
|
1486
|
+
/**
|
|
1487
|
+
* The second line of the address, if needed (e.g., apartment, suite, unit, or
|
|
1488
|
+
* building).
|
|
1489
|
+
*
|
|
1490
|
+
* Maximum length: 41 characters.
|
|
1491
|
+
*/
|
|
1492
|
+
line2?: string;
|
|
1493
|
+
/**
|
|
1494
|
+
* The third line of the address, if needed.
|
|
1495
|
+
*
|
|
1496
|
+
* Maximum length: 41 characters.
|
|
1497
|
+
*/
|
|
1498
|
+
line3?: string;
|
|
1499
|
+
/**
|
|
1500
|
+
* The fourth line of the address, if needed.
|
|
1501
|
+
*
|
|
1502
|
+
* Maximum length: 41 characters.
|
|
1503
|
+
*/
|
|
1504
|
+
line4?: string;
|
|
1505
|
+
/**
|
|
1506
|
+
* The fifth line of the address, if needed.
|
|
1507
|
+
*
|
|
1508
|
+
* Maximum length: 41 characters.
|
|
1509
|
+
*/
|
|
1510
|
+
line5?: string;
|
|
1511
|
+
/**
|
|
1512
|
+
* A note written at the bottom of the address in the form in which it appears,
|
|
1513
|
+
* such as the invoice form.
|
|
1514
|
+
*/
|
|
1515
|
+
note?: string;
|
|
1516
|
+
/**
|
|
1517
|
+
* The postal code or ZIP code of the address.
|
|
1518
|
+
*
|
|
1519
|
+
* Maximum length: 13 characters.
|
|
1520
|
+
*/
|
|
1521
|
+
postalCode?: string;
|
|
1522
|
+
/**
|
|
1523
|
+
* The state, county, province, or region name of the address.
|
|
1524
|
+
*
|
|
1525
|
+
* Maximum length: 21 characters.
|
|
1526
|
+
*/
|
|
1527
|
+
state?: string;
|
|
1528
|
+
}
|
|
1529
|
+
interface ApplyToTransaction {
|
|
1530
|
+
/**
|
|
1531
|
+
* The ID of the transaction to be paid by this check.
|
|
1532
|
+
*/
|
|
1533
|
+
transactionId: string;
|
|
1534
|
+
/**
|
|
1535
|
+
* The monetary amount from this check to apply to the specified transaction,
|
|
1536
|
+
* represented as a decimal string.
|
|
1537
|
+
*/
|
|
1538
|
+
amount?: string;
|
|
1539
|
+
}
|
|
1540
|
+
interface ExpenseLine {
|
|
1541
|
+
/**
|
|
1542
|
+
* The expense account being debited (increased) for this expense line. The
|
|
1543
|
+
* corresponding account being credited is usually a liability account (e.g.,
|
|
1544
|
+
* Accounts-Payable) or an asset account (e.g., Cash), depending on the transaction
|
|
1545
|
+
* type.
|
|
1546
|
+
*/
|
|
1547
|
+
accountId?: string;
|
|
1548
|
+
/**
|
|
1549
|
+
* The monetary amount of this expense line, represented as a decimal string.
|
|
1550
|
+
*/
|
|
1551
|
+
amount?: string;
|
|
1552
|
+
/**
|
|
1553
|
+
* The billing status of this expense line.
|
|
1554
|
+
*/
|
|
1555
|
+
billingStatus?: 'billable' | 'has_been_billed' | 'not_billable';
|
|
1556
|
+
/**
|
|
1557
|
+
* The expense line's class. Classes can be used to categorize objects into
|
|
1558
|
+
* meaningful segments, such as department, location, or type of work. In
|
|
1559
|
+
* QuickBooks, class tracking is off by default. If a class is specified for the
|
|
1560
|
+
* entire parent transaction, it is automatically applied to all expense lines
|
|
1561
|
+
* unless overridden here, at the transaction line level.
|
|
1562
|
+
*/
|
|
1563
|
+
classId?: string;
|
|
1564
|
+
/**
|
|
1565
|
+
* The custom fields for the expense line object, added as user-defined data
|
|
1566
|
+
* extensions, not included in the standard QuickBooks object.
|
|
1567
|
+
*/
|
|
1568
|
+
customFields?: Array<ExpenseLine.CustomField>;
|
|
1569
|
+
/**
|
|
1570
|
+
* A memo or note for this expense line.
|
|
1571
|
+
*/
|
|
1572
|
+
memo?: string;
|
|
1573
|
+
/**
|
|
1574
|
+
* If `account` refers to an Accounts-Payable (A/P) account, `payee` refers to the
|
|
1575
|
+
* expense's vendor (not the customer). If `account` refers to any other type of
|
|
1576
|
+
* account, `payee` refers to the expense's customer (not the vendor).
|
|
1577
|
+
*/
|
|
1578
|
+
payeeId?: string;
|
|
1579
|
+
/**
|
|
1580
|
+
* The expense line's sales representative. Sales representatives can be employees,
|
|
1581
|
+
* vendors, or other names in QuickBooks.
|
|
1582
|
+
*/
|
|
1583
|
+
salesRepresentativeId?: string;
|
|
1584
|
+
/**
|
|
1585
|
+
* The sales-tax code for this expense line, determining whether it is taxable or
|
|
1586
|
+
* non-taxable. If set, this overrides any sales-tax codes defined on the parent
|
|
1587
|
+
* transaction or the associated item.
|
|
1588
|
+
*
|
|
1589
|
+
* Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
|
|
1590
|
+
* can also be created in QuickBooks. If QuickBooks is not set up to charge sales
|
|
1591
|
+
* tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
|
|
1592
|
+
* non-taxable code to all sales.
|
|
1593
|
+
*/
|
|
1594
|
+
salesTaxCodeId?: string;
|
|
1595
|
+
}
|
|
1596
|
+
namespace ExpenseLine {
|
|
1597
|
+
interface CustomField {
|
|
1598
|
+
/**
|
|
1599
|
+
* The name of the custom field, unique for the specified `ownerId`. For public
|
|
1600
|
+
* custom fields, this name is visible as a label in the QuickBooks UI.
|
|
1601
|
+
*/
|
|
1602
|
+
name: string;
|
|
1603
|
+
/**
|
|
1604
|
+
* The identifier of the owner of the custom field, which QuickBooks internally
|
|
1605
|
+
* calls a "data extension". For public custom fields visible in the UI, such as
|
|
1606
|
+
* those added by the QuickBooks user, this is always "0". For private custom
|
|
1607
|
+
* fields that are only visible to the application that created them, this is a
|
|
1608
|
+
* valid GUID identifying the owning application. Internally, Conductor always
|
|
1609
|
+
* fetches all public custom fields (those with an `ownerId` of "0") for all
|
|
1610
|
+
* objects.
|
|
1611
|
+
*/
|
|
1612
|
+
ownerId: string;
|
|
1613
|
+
/**
|
|
1614
|
+
* The value of this custom field. The maximum length depends on the field's data
|
|
1615
|
+
* type.
|
|
1616
|
+
*/
|
|
1617
|
+
value: string;
|
|
1618
|
+
}
|
|
1619
|
+
}
|
|
1620
|
+
interface ItemGroupLine {
|
|
1621
|
+
/**
|
|
1622
|
+
* The item group line's item group, representing a predefined set of items bundled
|
|
1623
|
+
* because they are commonly purchased together or grouped for faster entry.
|
|
1624
|
+
*/
|
|
1625
|
+
itemGroupId: string;
|
|
1626
|
+
/**
|
|
1627
|
+
* The custom fields for the item group line object, added as user-defined data
|
|
1628
|
+
* extensions, not included in the standard QuickBooks object.
|
|
1629
|
+
*/
|
|
1630
|
+
customFields?: Array<ItemGroupLine.CustomField>;
|
|
1631
|
+
/**
|
|
1632
|
+
* The site location where inventory for the item group associated with this item
|
|
1633
|
+
* group line is stored.
|
|
1634
|
+
*/
|
|
1635
|
+
inventorySiteId?: string;
|
|
1636
|
+
/**
|
|
1637
|
+
* The specific location (e.g., bin or shelf) within the inventory site where the
|
|
1638
|
+
* item group associated with this item group line is stored.
|
|
1639
|
+
*/
|
|
1640
|
+
inventorySiteLocationId?: string;
|
|
1641
|
+
/**
|
|
1642
|
+
* The quantity of the item group associated with this item group line. This field
|
|
1643
|
+
* cannot be cleared.
|
|
1644
|
+
*
|
|
1645
|
+
* **NOTE**: Do not use this field if the associated item group is a discount item
|
|
1646
|
+
* group.
|
|
1647
|
+
*/
|
|
1648
|
+
quantity?: number;
|
|
1649
|
+
/**
|
|
1650
|
+
* The unit-of-measure used for the `quantity` in this item group line. Must be a
|
|
1651
|
+
* valid unit within the item's available units of measure.
|
|
1652
|
+
*/
|
|
1653
|
+
unitOfMeasure?: string;
|
|
1654
|
+
}
|
|
1655
|
+
namespace ItemGroupLine {
|
|
1656
|
+
interface CustomField {
|
|
1657
|
+
/**
|
|
1658
|
+
* The name of the custom field, unique for the specified `ownerId`. For public
|
|
1659
|
+
* custom fields, this name is visible as a label in the QuickBooks UI.
|
|
1660
|
+
*/
|
|
1661
|
+
name: string;
|
|
1662
|
+
/**
|
|
1663
|
+
* The identifier of the owner of the custom field, which QuickBooks internally
|
|
1664
|
+
* calls a "data extension". For public custom fields visible in the UI, such as
|
|
1665
|
+
* those added by the QuickBooks user, this is always "0". For private custom
|
|
1666
|
+
* fields that are only visible to the application that created them, this is a
|
|
1667
|
+
* valid GUID identifying the owning application. Internally, Conductor always
|
|
1668
|
+
* fetches all public custom fields (those with an `ownerId` of "0") for all
|
|
1669
|
+
* objects.
|
|
1670
|
+
*/
|
|
1671
|
+
ownerId: string;
|
|
1672
|
+
/**
|
|
1673
|
+
* The value of this custom field. The maximum length depends on the field's data
|
|
1674
|
+
* type.
|
|
1675
|
+
*/
|
|
1676
|
+
value: string;
|
|
1677
|
+
}
|
|
1678
|
+
}
|
|
1679
|
+
interface ItemLine {
|
|
1680
|
+
/**
|
|
1681
|
+
* The monetary amount of this item line, represented as a decimal string. If both
|
|
1682
|
+
* `quantity` and `cost` are specified but not `amount`, QuickBooks will use them
|
|
1683
|
+
* to calculate `amount`. If `amount`, `cost`, and `quantity` are all unspecified,
|
|
1684
|
+
* then QuickBooks will calculate `amount` based on a `quantity` of `1` and the
|
|
1685
|
+
* suggested `cost`. This field cannot be cleared.
|
|
1686
|
+
*/
|
|
1687
|
+
amount?: string;
|
|
1688
|
+
/**
|
|
1689
|
+
* The billing status of this item line.
|
|
1690
|
+
*/
|
|
1691
|
+
billingStatus?: 'billable' | 'has_been_billed' | 'not_billable';
|
|
1692
|
+
/**
|
|
1693
|
+
* The item line's class. Classes can be used to categorize objects into meaningful
|
|
1694
|
+
* segments, such as department, location, or type of work. In QuickBooks, class
|
|
1695
|
+
* tracking is off by default. If a class is specified for the entire parent
|
|
1696
|
+
* transaction, it is automatically applied to all item lines unless overridden
|
|
1697
|
+
* here, at the transaction line level.
|
|
1698
|
+
*/
|
|
1699
|
+
classId?: string;
|
|
1700
|
+
/**
|
|
1701
|
+
* The cost of this item line, represented as a decimal string. If both `quantity`
|
|
1702
|
+
* and `amount` are specified but not `cost`, QuickBooks will use them to calculate
|
|
1703
|
+
* `cost`.
|
|
1704
|
+
*/
|
|
1705
|
+
cost?: string;
|
|
1706
|
+
/**
|
|
1707
|
+
* The customer or customer-job associated with this item line.
|
|
1708
|
+
*/
|
|
1709
|
+
customerId?: string;
|
|
1710
|
+
/**
|
|
1711
|
+
* The custom fields for the item line object, added as user-defined data
|
|
1712
|
+
* extensions, not included in the standard QuickBooks object.
|
|
1713
|
+
*/
|
|
1714
|
+
customFields?: Array<ItemLine.CustomField>;
|
|
1715
|
+
/**
|
|
1716
|
+
* A description of this item line.
|
|
1717
|
+
*/
|
|
1718
|
+
description?: string;
|
|
1719
|
+
/**
|
|
1720
|
+
* The expiration date for the serial number or lot number of the item associated
|
|
1721
|
+
* with this item line, in ISO 8601 format (YYYY-MM-DD). This is particularly
|
|
1722
|
+
* relevant for perishable or time-sensitive inventory items. Note that this field
|
|
1723
|
+
* is only supported on QuickBooks Desktop 2023 or later.
|
|
1724
|
+
*/
|
|
1725
|
+
expirationDate?: string;
|
|
1726
|
+
/**
|
|
1727
|
+
* The site location where inventory for the item associated with this item line is
|
|
1728
|
+
* stored.
|
|
1729
|
+
*/
|
|
1730
|
+
inventorySiteId?: string;
|
|
1731
|
+
/**
|
|
1732
|
+
* The specific location (e.g., bin or shelf) within the inventory site where the
|
|
1733
|
+
* item associated with this item line is stored.
|
|
1734
|
+
*/
|
|
1735
|
+
inventorySiteLocationId?: string;
|
|
1736
|
+
/**
|
|
1737
|
+
* The item associated with this item line. This can refer to any good or service
|
|
1738
|
+
* that the business buys or sells, including item types such as a service item,
|
|
1739
|
+
* inventory item, or special calculation item like a discount item or sales-tax
|
|
1740
|
+
* item.
|
|
1741
|
+
*/
|
|
1742
|
+
itemId?: string;
|
|
1743
|
+
/**
|
|
1744
|
+
* An existing transaction line that you wish to link to this item line. Note that
|
|
1745
|
+
* this only links to a single transaction line item, not an entire transaction. If
|
|
1746
|
+
* you want to link an entire transaction and bring in all its lines, instead use
|
|
1747
|
+
* the field `linkToTransactionIds` on the parent transaction, if available. If the
|
|
1748
|
+
* parent transaction is a bill or an item receipt, you can only link to purchase
|
|
1749
|
+
* orders; QuickBooks does not support linking these transactions to other
|
|
1750
|
+
* transaction types.
|
|
1751
|
+
*
|
|
1752
|
+
* Transaction lines can only be linked when creating this item line and cannot be
|
|
1753
|
+
* unlinked later.
|
|
1754
|
+
*
|
|
1755
|
+
* **IMPORTANT**: If you use `linkToTransactionLine` on this item line, you cannot
|
|
1756
|
+
* use the field `item` on this line (QuickBooks will return an error) because this
|
|
1757
|
+
* field brings in all of the item information you need. You can, however, specify
|
|
1758
|
+
* whatever `quantity` or `rate` that you want, or any other transaction line
|
|
1759
|
+
* element other than `item`.
|
|
1760
|
+
*
|
|
1761
|
+
* If the parent transaction supports the `linkToTransactionIds` field, you can use
|
|
1762
|
+
* both `linkToTransactionLine` (on this item line) and `linkToTransactionIds` (on
|
|
1763
|
+
* its parent transaction) in the same request as long as they do NOT link to the
|
|
1764
|
+
* same transaction (otherwise, QuickBooks will return an error). QuickBooks will
|
|
1765
|
+
* also return an error if you attempt to link a transaction that is empty or
|
|
1766
|
+
* already closed.
|
|
1767
|
+
*
|
|
1768
|
+
* **IMPORTANT**: By default, QuickBooks will not return any information about the
|
|
1769
|
+
* linked transaction line in this endpoint's response even when this request is
|
|
1770
|
+
* successful. To see the transaction line linked via this field, refetch the
|
|
1771
|
+
* parent transaction and check the `linkedTransactions` response field. If
|
|
1772
|
+
* fetching a list of transactions, you must also specify the parameter
|
|
1773
|
+
* `includeLinkedTransactions=true` to see the `linkedTransactions` response field.
|
|
1774
|
+
*/
|
|
1775
|
+
linkToTransactionLine?: ItemLine.LinkToTransactionLine;
|
|
1776
|
+
/**
|
|
1777
|
+
* The lot number of the item associated with this item line. Used for tracking
|
|
1778
|
+
* groups of inventory items that are purchased or manufactured together.
|
|
1779
|
+
*/
|
|
1780
|
+
lotNumber?: string;
|
|
1781
|
+
/**
|
|
1782
|
+
* The account to use for this item line, overriding the default account associated
|
|
1783
|
+
* with the item.
|
|
1784
|
+
*/
|
|
1785
|
+
overrideItemAccountId?: string;
|
|
1786
|
+
/**
|
|
1787
|
+
* The quantity of the item associated with this item line. This field cannot be
|
|
1788
|
+
* cleared.
|
|
1789
|
+
*
|
|
1790
|
+
* **NOTE**: Do not use this field if the associated item is a discount item.
|
|
1791
|
+
*/
|
|
1792
|
+
quantity?: number;
|
|
1793
|
+
/**
|
|
1794
|
+
* The item line's sales representative. Sales representatives can be employees,
|
|
1795
|
+
* vendors, or other names in QuickBooks.
|
|
1796
|
+
*/
|
|
1797
|
+
salesRepresentativeId?: string;
|
|
1798
|
+
/**
|
|
1799
|
+
* The sales-tax code for this item line, determining whether it is taxable or
|
|
1800
|
+
* non-taxable. If set, this overrides any sales-tax codes defined on the parent
|
|
1801
|
+
* transaction or the associated item.
|
|
1802
|
+
*
|
|
1803
|
+
* Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
|
|
1804
|
+
* can also be created in QuickBooks. If QuickBooks is not set up to charge sales
|
|
1805
|
+
* tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
|
|
1806
|
+
* non-taxable code to all sales.
|
|
1807
|
+
*/
|
|
1808
|
+
salesTaxCodeId?: string;
|
|
1809
|
+
/**
|
|
1810
|
+
* The serial number of the item associated with this item line. This is used for
|
|
1811
|
+
* tracking individual units of serialized inventory items.
|
|
1812
|
+
*/
|
|
1813
|
+
serialNumber?: string;
|
|
1814
|
+
/**
|
|
1815
|
+
* The unit-of-measure used for the `quantity` in this item line. Must be a valid
|
|
1816
|
+
* unit within the item's available units of measure.
|
|
1817
|
+
*/
|
|
1818
|
+
unitOfMeasure?: string;
|
|
1819
|
+
}
|
|
1820
|
+
namespace ItemLine {
|
|
1821
|
+
interface CustomField {
|
|
1822
|
+
/**
|
|
1823
|
+
* The name of the custom field, unique for the specified `ownerId`. For public
|
|
1824
|
+
* custom fields, this name is visible as a label in the QuickBooks UI.
|
|
1825
|
+
*/
|
|
1826
|
+
name: string;
|
|
1827
|
+
/**
|
|
1828
|
+
* The identifier of the owner of the custom field, which QuickBooks internally
|
|
1829
|
+
* calls a "data extension". For public custom fields visible in the UI, such as
|
|
1830
|
+
* those added by the QuickBooks user, this is always "0". For private custom
|
|
1831
|
+
* fields that are only visible to the application that created them, this is a
|
|
1832
|
+
* valid GUID identifying the owning application. Internally, Conductor always
|
|
1833
|
+
* fetches all public custom fields (those with an `ownerId` of "0") for all
|
|
1834
|
+
* objects.
|
|
1835
|
+
*/
|
|
1836
|
+
ownerId: string;
|
|
1837
|
+
/**
|
|
1838
|
+
* The value of this custom field. The maximum length depends on the field's data
|
|
1839
|
+
* type.
|
|
1840
|
+
*/
|
|
1841
|
+
value: string;
|
|
1842
|
+
}
|
|
1843
|
+
/**
|
|
1844
|
+
* An existing transaction line that you wish to link to this item line. Note that
|
|
1845
|
+
* this only links to a single transaction line item, not an entire transaction. If
|
|
1846
|
+
* you want to link an entire transaction and bring in all its lines, instead use
|
|
1847
|
+
* the field `linkToTransactionIds` on the parent transaction, if available. If the
|
|
1848
|
+
* parent transaction is a bill or an item receipt, you can only link to purchase
|
|
1849
|
+
* orders; QuickBooks does not support linking these transactions to other
|
|
1850
|
+
* transaction types.
|
|
1851
|
+
*
|
|
1852
|
+
* Transaction lines can only be linked when creating this item line and cannot be
|
|
1853
|
+
* unlinked later.
|
|
1854
|
+
*
|
|
1855
|
+
* **IMPORTANT**: If you use `linkToTransactionLine` on this item line, you cannot
|
|
1856
|
+
* use the field `item` on this line (QuickBooks will return an error) because this
|
|
1857
|
+
* field brings in all of the item information you need. You can, however, specify
|
|
1858
|
+
* whatever `quantity` or `rate` that you want, or any other transaction line
|
|
1859
|
+
* element other than `item`.
|
|
1860
|
+
*
|
|
1861
|
+
* If the parent transaction supports the `linkToTransactionIds` field, you can use
|
|
1862
|
+
* both `linkToTransactionLine` (on this item line) and `linkToTransactionIds` (on
|
|
1863
|
+
* its parent transaction) in the same request as long as they do NOT link to the
|
|
1864
|
+
* same transaction (otherwise, QuickBooks will return an error). QuickBooks will
|
|
1865
|
+
* also return an error if you attempt to link a transaction that is empty or
|
|
1866
|
+
* already closed.
|
|
1867
|
+
*
|
|
1868
|
+
* **IMPORTANT**: By default, QuickBooks will not return any information about the
|
|
1869
|
+
* linked transaction line in this endpoint's response even when this request is
|
|
1870
|
+
* successful. To see the transaction line linked via this field, refetch the
|
|
1871
|
+
* parent transaction and check the `linkedTransactions` response field. If
|
|
1872
|
+
* fetching a list of transactions, you must also specify the parameter
|
|
1873
|
+
* `includeLinkedTransactions=true` to see the `linkedTransactions` response field.
|
|
1874
|
+
*/
|
|
1875
|
+
interface LinkToTransactionLine {
|
|
1876
|
+
/**
|
|
1877
|
+
* The ID of the transaction to which to link this transaction.
|
|
1878
|
+
*/
|
|
1879
|
+
transactionId: string;
|
|
1880
|
+
/**
|
|
1881
|
+
* The ID of the transaction line to which to link this transaction.
|
|
1882
|
+
*/
|
|
1883
|
+
transactionLineId: string;
|
|
1884
|
+
}
|
|
1885
|
+
}
|
|
1886
|
+
}
|
|
1887
|
+
export interface CheckRetrieveParams {
|
|
1888
|
+
/**
|
|
1889
|
+
* The ID of the End-User to receive this request.
|
|
1890
|
+
*/
|
|
1891
|
+
conductorEndUserId: string;
|
|
1892
|
+
}
|
|
1893
|
+
export interface CheckUpdateParams {
|
|
1894
|
+
/**
|
|
1895
|
+
* Body param: The current QuickBooks-assigned revision number of the check object
|
|
1896
|
+
* you are updating, which you can get by fetching the object first. Provide the
|
|
1897
|
+
* most recent `revisionNumber` to ensure you're working with the latest data;
|
|
1898
|
+
* otherwise, the update will return an error.
|
|
1899
|
+
*/
|
|
1900
|
+
revisionNumber: string;
|
|
1901
|
+
/**
|
|
1902
|
+
* Header param: The ID of the End-User to receive this request.
|
|
1903
|
+
*/
|
|
1904
|
+
conductorEndUserId: string;
|
|
1905
|
+
/**
|
|
1906
|
+
* Body param: The address that is printed on the check.
|
|
1907
|
+
*/
|
|
1908
|
+
address?: CheckUpdateParams.Address;
|
|
1909
|
+
/**
|
|
1910
|
+
* Body param: Transactions to be paid by this check. This will create a link
|
|
1911
|
+
* between this check and the specified transactions.
|
|
1912
|
+
*
|
|
1913
|
+
* **IMPORTANT**: By default, QuickBooks will not return any information about the
|
|
1914
|
+
* linked transactions in this endpoint's response even when this request is
|
|
1915
|
+
* successful. To see the transactions linked via this field, refetch the check and
|
|
1916
|
+
* check the `linkedTransactions` response field. If fetching a list of checks, you
|
|
1917
|
+
* must also specify the parameter `includeLinkedTransactions=true` to see the
|
|
1918
|
+
* `linkedTransactions` response field.
|
|
1919
|
+
*/
|
|
1920
|
+
applyToTransactions?: Array<CheckUpdateParams.ApplyToTransaction>;
|
|
1921
|
+
/**
|
|
1922
|
+
* Body param: The bank account from which the funds are being drawn for this
|
|
1923
|
+
* check; e.g., Checking or Savings. This check will decrease the balance of this
|
|
1924
|
+
* account.
|
|
1925
|
+
*/
|
|
1926
|
+
bankAccountId?: string;
|
|
1927
|
+
/**
|
|
1928
|
+
* Body param: When `true`, removes all existing expense lines associated with this
|
|
1929
|
+
* check. To modify or add individual expense lines, use the field `expenseLines`
|
|
1930
|
+
* instead.
|
|
1931
|
+
*/
|
|
1932
|
+
clearExpenseLines?: boolean;
|
|
1933
|
+
/**
|
|
1934
|
+
* Body param: When `true`, removes all existing item lines associated with this
|
|
1935
|
+
* check. To modify or add individual item lines, use the field `itemLines`
|
|
1936
|
+
* instead.
|
|
1937
|
+
*/
|
|
1938
|
+
clearItemLines?: boolean;
|
|
1939
|
+
/**
|
|
1940
|
+
* Body param: The market exchange rate between this check's currency and the home
|
|
1941
|
+
* currency in QuickBooks at the time of this transaction. Represented as a decimal
|
|
1942
|
+
* value (e.g., 1.2345 for 1 EUR = 1.2345 USD if USD is the home currency).
|
|
1943
|
+
*/
|
|
1944
|
+
exchangeRate?: number;
|
|
1945
|
+
/**
|
|
1946
|
+
* Body param: The check's expense lines, each representing one line in this
|
|
1947
|
+
* expense.
|
|
1948
|
+
*
|
|
1949
|
+
* **IMPORTANT**:
|
|
1950
|
+
*
|
|
1951
|
+
* 1. Including this array in your update request will **REPLACE** all existing
|
|
1952
|
+
* expense lines for the check with this array. To keep any existing expense
|
|
1953
|
+
* lines, you must include them in this array even if they have not changed.
|
|
1954
|
+
* **Any expense lines not included will be removed.**
|
|
1955
|
+
*
|
|
1956
|
+
* 2. To add a new expense line, include it here with the `id` field set to `-1`.
|
|
1957
|
+
*
|
|
1958
|
+
* 3. If you do not wish to modify any expense lines, omit this field entirely to
|
|
1959
|
+
* keep them unchanged.
|
|
1960
|
+
*/
|
|
1961
|
+
expenseLines?: Array<CheckUpdateParams.ExpenseLine>;
|
|
1962
|
+
/**
|
|
1963
|
+
* Body param: Indicates whether this check is included in the queue of documents
|
|
1964
|
+
* for QuickBooks to print.
|
|
1965
|
+
*/
|
|
1966
|
+
isQueuedForPrint?: boolean;
|
|
1967
|
+
/**
|
|
1968
|
+
* Body param: The check's item group lines, each representing a predefined set of
|
|
1969
|
+
* items bundled together because they are commonly purchased together or grouped
|
|
1970
|
+
* for faster entry.
|
|
1971
|
+
*
|
|
1972
|
+
* **IMPORTANT**:
|
|
1973
|
+
*
|
|
1974
|
+
* 1. Including this array in your update request will **REPLACE** all existing
|
|
1975
|
+
* item group lines for the check with this array. To keep any existing item
|
|
1976
|
+
* group lines, you must include them in this array even if they have not
|
|
1977
|
+
* changed. **Any item group lines not included will be removed.**
|
|
1978
|
+
*
|
|
1979
|
+
* 2. To add a new item group line, include it here with the `id` field set to
|
|
1980
|
+
* `-1`.
|
|
1981
|
+
*
|
|
1982
|
+
* 3. If you do not wish to modify any item group lines, omit this field entirely
|
|
1983
|
+
* to keep them unchanged.
|
|
1984
|
+
*/
|
|
1985
|
+
itemGroupLines?: Array<CheckUpdateParams.ItemGroupLine>;
|
|
1986
|
+
/**
|
|
1987
|
+
* Body param: The check's item lines, each representing the purchase of a specific
|
|
1988
|
+
* item or service.
|
|
1989
|
+
*
|
|
1990
|
+
* **IMPORTANT**:
|
|
1991
|
+
*
|
|
1992
|
+
* 1. Including this array in your update request will **REPLACE** all existing
|
|
1993
|
+
* item lines for the check with this array. To keep any existing item lines,
|
|
1994
|
+
* you must include them in this array even if they have not changed. **Any item
|
|
1995
|
+
* lines not included will be removed.**
|
|
1996
|
+
*
|
|
1997
|
+
* 2. To add a new item line, include it here with the `id` field set to `-1`.
|
|
1998
|
+
*
|
|
1999
|
+
* 3. If you do not wish to modify any item lines, omit this field entirely to keep
|
|
2000
|
+
* them unchanged.
|
|
2001
|
+
*/
|
|
2002
|
+
itemLines?: Array<CheckUpdateParams.ItemLine>;
|
|
2003
|
+
/**
|
|
2004
|
+
* Body param: The memo that is printed on this check.
|
|
2005
|
+
*/
|
|
2006
|
+
memo?: string;
|
|
2007
|
+
/**
|
|
2008
|
+
* Body param: The person or company who will receive this check.
|
|
2009
|
+
*/
|
|
2010
|
+
payeeId?: string;
|
|
2011
|
+
/**
|
|
2012
|
+
* Body param: The case-sensitive user-defined reference number for this check,
|
|
2013
|
+
* which can be used to identify the transaction in QuickBooks. This value is not
|
|
2014
|
+
* required to be unique and can be arbitrarily changed by the QuickBooks user.
|
|
2015
|
+
*
|
|
2016
|
+
* **IMPORTANT**: For checks, this field is the check number.
|
|
2017
|
+
*/
|
|
2018
|
+
refNumber?: string;
|
|
2019
|
+
/**
|
|
2020
|
+
* Body param: The sales-tax code for this check, determining whether it is taxable
|
|
2021
|
+
* or non-taxable. If set, this overrides any sales-tax codes defined on the payee.
|
|
2022
|
+
* This can be overridden on the check's individual lines.
|
|
2023
|
+
*
|
|
2024
|
+
* Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
|
|
2025
|
+
* can also be created in QuickBooks. If QuickBooks is not set up to charge sales
|
|
2026
|
+
* tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
|
|
2027
|
+
* non-taxable code to all sales.
|
|
2028
|
+
*/
|
|
2029
|
+
salesTaxCodeId?: string;
|
|
2030
|
+
/**
|
|
2031
|
+
* Body param: The date written on this check, in ISO 8601 format (YYYY-MM-DD).
|
|
2032
|
+
*/
|
|
2033
|
+
transactionDate?: string;
|
|
2034
|
+
}
|
|
2035
|
+
export declare namespace CheckUpdateParams {
|
|
2036
|
+
/**
|
|
2037
|
+
* The address that is printed on the check.
|
|
2038
|
+
*/
|
|
2039
|
+
interface Address {
|
|
2040
|
+
/**
|
|
2041
|
+
* The city, district, suburb, town, or village name of the address.
|
|
2042
|
+
*
|
|
2043
|
+
* Maximum length: 31 characters.
|
|
2044
|
+
*/
|
|
2045
|
+
city?: string;
|
|
2046
|
+
/**
|
|
2047
|
+
* The country name of the address.
|
|
2048
|
+
*/
|
|
2049
|
+
country?: string;
|
|
2050
|
+
/**
|
|
2051
|
+
* The first line of the address (e.g., street, PO Box, or company name).
|
|
2052
|
+
*
|
|
2053
|
+
* Maximum length: 41 characters.
|
|
2054
|
+
*/
|
|
2055
|
+
line1?: string;
|
|
2056
|
+
/**
|
|
2057
|
+
* The second line of the address, if needed (e.g., apartment, suite, unit, or
|
|
2058
|
+
* building).
|
|
2059
|
+
*
|
|
2060
|
+
* Maximum length: 41 characters.
|
|
2061
|
+
*/
|
|
2062
|
+
line2?: string;
|
|
2063
|
+
/**
|
|
2064
|
+
* The third line of the address, if needed.
|
|
2065
|
+
*
|
|
2066
|
+
* Maximum length: 41 characters.
|
|
2067
|
+
*/
|
|
2068
|
+
line3?: string;
|
|
2069
|
+
/**
|
|
2070
|
+
* The fourth line of the address, if needed.
|
|
2071
|
+
*
|
|
2072
|
+
* Maximum length: 41 characters.
|
|
2073
|
+
*/
|
|
2074
|
+
line4?: string;
|
|
2075
|
+
/**
|
|
2076
|
+
* The fifth line of the address, if needed.
|
|
2077
|
+
*
|
|
2078
|
+
* Maximum length: 41 characters.
|
|
2079
|
+
*/
|
|
2080
|
+
line5?: string;
|
|
2081
|
+
/**
|
|
2082
|
+
* A note written at the bottom of the address in the form in which it appears,
|
|
2083
|
+
* such as the invoice form.
|
|
2084
|
+
*/
|
|
2085
|
+
note?: string;
|
|
2086
|
+
/**
|
|
2087
|
+
* The postal code or ZIP code of the address.
|
|
2088
|
+
*
|
|
2089
|
+
* Maximum length: 13 characters.
|
|
2090
|
+
*/
|
|
2091
|
+
postalCode?: string;
|
|
2092
|
+
/**
|
|
2093
|
+
* The state, county, province, or region name of the address.
|
|
2094
|
+
*
|
|
2095
|
+
* Maximum length: 21 characters.
|
|
2096
|
+
*/
|
|
2097
|
+
state?: string;
|
|
2098
|
+
}
|
|
2099
|
+
interface ApplyToTransaction {
|
|
2100
|
+
/**
|
|
2101
|
+
* The ID of the transaction to be paid by this check.
|
|
2102
|
+
*/
|
|
2103
|
+
transactionId: string;
|
|
2104
|
+
/**
|
|
2105
|
+
* The monetary amount from this check to apply to the specified transaction,
|
|
2106
|
+
* represented as a decimal string.
|
|
2107
|
+
*/
|
|
2108
|
+
amount?: string;
|
|
2109
|
+
}
|
|
2110
|
+
interface ExpenseLine {
|
|
2111
|
+
/**
|
|
2112
|
+
* The QuickBooks-assigned unique identifier of an existing expense line you wish
|
|
2113
|
+
* to retain or update.
|
|
2114
|
+
*
|
|
2115
|
+
* **IMPORTANT**: Set this field to `-1` for new expense lines you wish to add.
|
|
2116
|
+
*/
|
|
2117
|
+
id: string;
|
|
2118
|
+
/**
|
|
2119
|
+
* The expense account being debited (increased) for this expense line. The
|
|
2120
|
+
* corresponding account being credited is usually a liability account (e.g.,
|
|
2121
|
+
* Accounts-Payable) or an asset account (e.g., Cash), depending on the transaction
|
|
2122
|
+
* type.
|
|
2123
|
+
*/
|
|
2124
|
+
accountId?: string;
|
|
2125
|
+
/**
|
|
2126
|
+
* The monetary amount of this expense line, represented as a decimal string.
|
|
2127
|
+
*/
|
|
2128
|
+
amount?: string;
|
|
2129
|
+
/**
|
|
2130
|
+
* The billing status of this expense line.
|
|
2131
|
+
*/
|
|
2132
|
+
billingStatus?: 'billable' | 'has_been_billed' | 'not_billable';
|
|
2133
|
+
/**
|
|
2134
|
+
* The expense line's class. Classes can be used to categorize objects into
|
|
2135
|
+
* meaningful segments, such as department, location, or type of work. In
|
|
2136
|
+
* QuickBooks, class tracking is off by default. If a class is specified for the
|
|
2137
|
+
* entire parent transaction, it is automatically applied to all expense lines
|
|
2138
|
+
* unless overridden here, at the transaction line level.
|
|
2139
|
+
*/
|
|
2140
|
+
classId?: string;
|
|
2141
|
+
/**
|
|
2142
|
+
* A memo or note for this expense line.
|
|
2143
|
+
*/
|
|
2144
|
+
memo?: string;
|
|
2145
|
+
/**
|
|
2146
|
+
* If `account` refers to an Accounts-Payable (A/P) account, `payee` refers to the
|
|
2147
|
+
* expense's vendor (not the customer). If `account` refers to any other type of
|
|
2148
|
+
* account, `payee` refers to the expense's customer (not the vendor).
|
|
2149
|
+
*/
|
|
2150
|
+
payeeId?: string;
|
|
2151
|
+
/**
|
|
2152
|
+
* The expense line's sales representative. Sales representatives can be employees,
|
|
2153
|
+
* vendors, or other names in QuickBooks.
|
|
2154
|
+
*/
|
|
2155
|
+
salesRepresentativeId?: string;
|
|
2156
|
+
/**
|
|
2157
|
+
* The sales-tax code for this expense line, determining whether it is taxable or
|
|
2158
|
+
* non-taxable. If set, this overrides any sales-tax codes defined on the parent
|
|
2159
|
+
* transaction or the associated item.
|
|
2160
|
+
*
|
|
2161
|
+
* Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
|
|
2162
|
+
* can also be created in QuickBooks. If QuickBooks is not set up to charge sales
|
|
2163
|
+
* tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
|
|
2164
|
+
* non-taxable code to all sales.
|
|
2165
|
+
*/
|
|
2166
|
+
salesTaxCodeId?: string;
|
|
2167
|
+
}
|
|
2168
|
+
interface ItemGroupLine {
|
|
2169
|
+
/**
|
|
2170
|
+
* The QuickBooks-assigned unique identifier of an existing item group line you
|
|
2171
|
+
* wish to retain or update.
|
|
2172
|
+
*
|
|
2173
|
+
* **IMPORTANT**: Set this field to `-1` for new item group lines you wish to add.
|
|
2174
|
+
*/
|
|
2175
|
+
id: string;
|
|
2176
|
+
/**
|
|
2177
|
+
* The item group line's item group, representing a predefined set of items bundled
|
|
2178
|
+
* because they are commonly purchased together or grouped for faster entry.
|
|
2179
|
+
*/
|
|
2180
|
+
itemGroupId?: string;
|
|
2181
|
+
/**
|
|
2182
|
+
* The item group line's item lines, each representing the purchase of a specific
|
|
2183
|
+
* item or service.
|
|
2184
|
+
*
|
|
2185
|
+
* **IMPORTANT**:
|
|
2186
|
+
*
|
|
2187
|
+
* 1. Including this array in your update request will **REPLACE** all existing
|
|
2188
|
+
* item lines for the item group line with this array. To keep any existing item
|
|
2189
|
+
* lines, you must include them in this array even if they have not changed.
|
|
2190
|
+
* **Any item lines not included will be removed.**
|
|
2191
|
+
*
|
|
2192
|
+
* 2. To add a new item line, include it here with the `id` field set to `-1`.
|
|
2193
|
+
*
|
|
2194
|
+
* 3. If you do not wish to modify any item lines, omit this field entirely to keep
|
|
2195
|
+
* them unchanged.
|
|
2196
|
+
*/
|
|
2197
|
+
itemLines?: Array<ItemGroupLine.ItemLine>;
|
|
2198
|
+
/**
|
|
2199
|
+
* Specifies an alternative unit-of-measure set when updating this item group
|
|
2200
|
+
* line's `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to
|
|
2201
|
+
* select units from a different set than the item's default unit-of-measure set,
|
|
2202
|
+
* which remains unchanged on the item itself. The override applies only to this
|
|
2203
|
+
* specific line. For example, you can sell an item typically measured in volume
|
|
2204
|
+
* units using weight units in a specific transaction by specifying a different
|
|
2205
|
+
* unit-of-measure set with this field.
|
|
2206
|
+
*/
|
|
2207
|
+
overrideUnitOfMeasureSetId?: string;
|
|
2208
|
+
/**
|
|
2209
|
+
* The quantity of the item group associated with this item group line. This field
|
|
2210
|
+
* cannot be cleared.
|
|
2211
|
+
*
|
|
2212
|
+
* **NOTE**: Do not use this field if the associated item group is a discount item
|
|
2213
|
+
* group.
|
|
2214
|
+
*/
|
|
2215
|
+
quantity?: number;
|
|
2216
|
+
/**
|
|
2217
|
+
* The unit-of-measure used for the `quantity` in this item group line. Must be a
|
|
2218
|
+
* valid unit within the item's available units of measure.
|
|
2219
|
+
*/
|
|
2220
|
+
unitOfMeasure?: string;
|
|
2221
|
+
}
|
|
2222
|
+
namespace ItemGroupLine {
|
|
2223
|
+
interface ItemLine {
|
|
2224
|
+
/**
|
|
2225
|
+
* The QuickBooks-assigned unique identifier of an existing item line you wish to
|
|
2226
|
+
* retain or update.
|
|
2227
|
+
*
|
|
2228
|
+
* **IMPORTANT**: Set this field to `-1` for new item lines you wish to add.
|
|
2229
|
+
*/
|
|
2230
|
+
id: string;
|
|
2231
|
+
/**
|
|
2232
|
+
* The monetary amount of this item line, represented as a decimal string. If both
|
|
2233
|
+
* `quantity` and `cost` are specified but not `amount`, QuickBooks will use them
|
|
2234
|
+
* to calculate `amount`. If `amount`, `cost`, and `quantity` are all unspecified,
|
|
2235
|
+
* then QuickBooks will calculate `amount` based on a `quantity` of `1` and the
|
|
2236
|
+
* suggested `cost`. This field cannot be cleared.
|
|
2237
|
+
*/
|
|
2238
|
+
amount?: string;
|
|
2239
|
+
/**
|
|
2240
|
+
* The billing status of this item line.
|
|
2241
|
+
*/
|
|
2242
|
+
billingStatus?: 'billable' | 'has_been_billed' | 'not_billable';
|
|
2243
|
+
/**
|
|
2244
|
+
* The item line's class. Classes can be used to categorize objects into meaningful
|
|
2245
|
+
* segments, such as department, location, or type of work. In QuickBooks, class
|
|
2246
|
+
* tracking is off by default. If a class is specified for the entire parent
|
|
2247
|
+
* transaction, it is automatically applied to all item lines unless overridden
|
|
2248
|
+
* here, at the transaction line level.
|
|
2249
|
+
*/
|
|
2250
|
+
classId?: string;
|
|
2251
|
+
/**
|
|
2252
|
+
* The cost of this item line, represented as a decimal string. If both `quantity`
|
|
2253
|
+
* and `amount` are specified but not `cost`, QuickBooks will use them to calculate
|
|
2254
|
+
* `cost`.
|
|
2255
|
+
*/
|
|
2256
|
+
cost?: string;
|
|
2257
|
+
/**
|
|
2258
|
+
* The customer or customer-job associated with this item line.
|
|
2259
|
+
*/
|
|
2260
|
+
customerId?: string;
|
|
2261
|
+
/**
|
|
2262
|
+
* A description of this item line.
|
|
2263
|
+
*/
|
|
2264
|
+
description?: string;
|
|
2265
|
+
/**
|
|
2266
|
+
* The expiration date for the serial number or lot number of the item associated
|
|
2267
|
+
* with this item line, in ISO 8601 format (YYYY-MM-DD). This is particularly
|
|
2268
|
+
* relevant for perishable or time-sensitive inventory items. Note that this field
|
|
2269
|
+
* is only supported on QuickBooks Desktop 2023 or later.
|
|
2270
|
+
*/
|
|
2271
|
+
expirationDate?: string;
|
|
2272
|
+
/**
|
|
2273
|
+
* The site location where inventory for the item associated with this item line is
|
|
2274
|
+
* stored.
|
|
2275
|
+
*/
|
|
2276
|
+
inventorySiteId?: string;
|
|
2277
|
+
/**
|
|
2278
|
+
* The specific location (e.g., bin or shelf) within the inventory site where the
|
|
2279
|
+
* item associated with this item line is stored.
|
|
2280
|
+
*/
|
|
2281
|
+
inventorySiteLocationId?: string;
|
|
2282
|
+
/**
|
|
2283
|
+
* The item associated with this item line. This can refer to any good or service
|
|
2284
|
+
* that the business buys or sells, including item types such as a service item,
|
|
2285
|
+
* inventory item, or special calculation item like a discount item or sales-tax
|
|
2286
|
+
* item.
|
|
2287
|
+
*/
|
|
2288
|
+
itemId?: string;
|
|
2289
|
+
/**
|
|
2290
|
+
* The lot number of the item associated with this item line. Used for tracking
|
|
2291
|
+
* groups of inventory items that are purchased or manufactured together.
|
|
2292
|
+
*/
|
|
2293
|
+
lotNumber?: string;
|
|
2294
|
+
/**
|
|
2295
|
+
* The account to use for this item line, overriding the default account associated
|
|
2296
|
+
* with the item.
|
|
2297
|
+
*/
|
|
2298
|
+
overrideItemAccountId?: string;
|
|
2299
|
+
/**
|
|
2300
|
+
* Specifies an alternative unit-of-measure set when updating this item line's
|
|
2301
|
+
* `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to select
|
|
2302
|
+
* units from a different set than the item's default unit-of-measure set, which
|
|
2303
|
+
* remains unchanged on the item itself. The override applies only to this specific
|
|
2304
|
+
* line. For example, you can sell an item typically measured in volume units using
|
|
2305
|
+
* weight units in a specific transaction by specifying a different unit-of-measure
|
|
2306
|
+
* set with this field.
|
|
2307
|
+
*/
|
|
2308
|
+
overrideUnitOfMeasureSetId?: string;
|
|
2309
|
+
/**
|
|
2310
|
+
* The quantity of the item associated with this item line. This field cannot be
|
|
2311
|
+
* cleared.
|
|
2312
|
+
*
|
|
2313
|
+
* **NOTE**: Do not use this field if the associated item is a discount item.
|
|
2314
|
+
*/
|
|
2315
|
+
quantity?: number;
|
|
2316
|
+
/**
|
|
2317
|
+
* The item line's sales representative. Sales representatives can be employees,
|
|
2318
|
+
* vendors, or other names in QuickBooks.
|
|
2319
|
+
*/
|
|
2320
|
+
salesRepresentativeId?: string;
|
|
2321
|
+
/**
|
|
2322
|
+
* The sales-tax code for this item line, determining whether it is taxable or
|
|
2323
|
+
* non-taxable. If set, this overrides any sales-tax codes defined on the parent
|
|
2324
|
+
* transaction or the associated item.
|
|
2325
|
+
*
|
|
2326
|
+
* Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
|
|
2327
|
+
* can also be created in QuickBooks. If QuickBooks is not set up to charge sales
|
|
2328
|
+
* tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
|
|
2329
|
+
* non-taxable code to all sales.
|
|
2330
|
+
*/
|
|
2331
|
+
salesTaxCodeId?: string;
|
|
2332
|
+
/**
|
|
2333
|
+
* The serial number of the item associated with this item line. This is used for
|
|
2334
|
+
* tracking individual units of serialized inventory items.
|
|
2335
|
+
*/
|
|
2336
|
+
serialNumber?: string;
|
|
2337
|
+
/**
|
|
2338
|
+
* The unit-of-measure used for the `quantity` in this item line. Must be a valid
|
|
2339
|
+
* unit within the item's available units of measure.
|
|
2340
|
+
*/
|
|
2341
|
+
unitOfMeasure?: string;
|
|
2342
|
+
}
|
|
2343
|
+
}
|
|
2344
|
+
interface ItemLine {
|
|
2345
|
+
/**
|
|
2346
|
+
* The QuickBooks-assigned unique identifier of an existing item line you wish to
|
|
2347
|
+
* retain or update.
|
|
2348
|
+
*
|
|
2349
|
+
* **IMPORTANT**: Set this field to `-1` for new item lines you wish to add.
|
|
2350
|
+
*/
|
|
2351
|
+
id: string;
|
|
2352
|
+
/**
|
|
2353
|
+
* The monetary amount of this item line, represented as a decimal string. If both
|
|
2354
|
+
* `quantity` and `cost` are specified but not `amount`, QuickBooks will use them
|
|
2355
|
+
* to calculate `amount`. If `amount`, `cost`, and `quantity` are all unspecified,
|
|
2356
|
+
* then QuickBooks will calculate `amount` based on a `quantity` of `1` and the
|
|
2357
|
+
* suggested `cost`. This field cannot be cleared.
|
|
2358
|
+
*/
|
|
2359
|
+
amount?: string;
|
|
2360
|
+
/**
|
|
2361
|
+
* The billing status of this item line.
|
|
2362
|
+
*/
|
|
2363
|
+
billingStatus?: 'billable' | 'has_been_billed' | 'not_billable';
|
|
2364
|
+
/**
|
|
2365
|
+
* The item line's class. Classes can be used to categorize objects into meaningful
|
|
2366
|
+
* segments, such as department, location, or type of work. In QuickBooks, class
|
|
2367
|
+
* tracking is off by default. If a class is specified for the entire parent
|
|
2368
|
+
* transaction, it is automatically applied to all item lines unless overridden
|
|
2369
|
+
* here, at the transaction line level.
|
|
2370
|
+
*/
|
|
2371
|
+
classId?: string;
|
|
2372
|
+
/**
|
|
2373
|
+
* The cost of this item line, represented as a decimal string. If both `quantity`
|
|
2374
|
+
* and `amount` are specified but not `cost`, QuickBooks will use them to calculate
|
|
2375
|
+
* `cost`.
|
|
2376
|
+
*/
|
|
2377
|
+
cost?: string;
|
|
2378
|
+
/**
|
|
2379
|
+
* The customer or customer-job associated with this item line.
|
|
2380
|
+
*/
|
|
2381
|
+
customerId?: string;
|
|
2382
|
+
/**
|
|
2383
|
+
* A description of this item line.
|
|
2384
|
+
*/
|
|
2385
|
+
description?: string;
|
|
2386
|
+
/**
|
|
2387
|
+
* The expiration date for the serial number or lot number of the item associated
|
|
2388
|
+
* with this item line, in ISO 8601 format (YYYY-MM-DD). This is particularly
|
|
2389
|
+
* relevant for perishable or time-sensitive inventory items. Note that this field
|
|
2390
|
+
* is only supported on QuickBooks Desktop 2023 or later.
|
|
2391
|
+
*/
|
|
2392
|
+
expirationDate?: string;
|
|
2393
|
+
/**
|
|
2394
|
+
* The site location where inventory for the item associated with this item line is
|
|
2395
|
+
* stored.
|
|
2396
|
+
*/
|
|
2397
|
+
inventorySiteId?: string;
|
|
2398
|
+
/**
|
|
2399
|
+
* The specific location (e.g., bin or shelf) within the inventory site where the
|
|
2400
|
+
* item associated with this item line is stored.
|
|
2401
|
+
*/
|
|
2402
|
+
inventorySiteLocationId?: string;
|
|
2403
|
+
/**
|
|
2404
|
+
* The item associated with this item line. This can refer to any good or service
|
|
2405
|
+
* that the business buys or sells, including item types such as a service item,
|
|
2406
|
+
* inventory item, or special calculation item like a discount item or sales-tax
|
|
2407
|
+
* item.
|
|
2408
|
+
*/
|
|
2409
|
+
itemId?: string;
|
|
2410
|
+
/**
|
|
2411
|
+
* The lot number of the item associated with this item line. Used for tracking
|
|
2412
|
+
* groups of inventory items that are purchased or manufactured together.
|
|
2413
|
+
*/
|
|
2414
|
+
lotNumber?: string;
|
|
2415
|
+
/**
|
|
2416
|
+
* The account to use for this item line, overriding the default account associated
|
|
2417
|
+
* with the item.
|
|
2418
|
+
*/
|
|
2419
|
+
overrideItemAccountId?: string;
|
|
2420
|
+
/**
|
|
2421
|
+
* Specifies an alternative unit-of-measure set when updating this item line's
|
|
2422
|
+
* `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to select
|
|
2423
|
+
* units from a different set than the item's default unit-of-measure set, which
|
|
2424
|
+
* remains unchanged on the item itself. The override applies only to this specific
|
|
2425
|
+
* line. For example, you can sell an item typically measured in volume units using
|
|
2426
|
+
* weight units in a specific transaction by specifying a different unit-of-measure
|
|
2427
|
+
* set with this field.
|
|
2428
|
+
*/
|
|
2429
|
+
overrideUnitOfMeasureSetId?: string;
|
|
2430
|
+
/**
|
|
2431
|
+
* The quantity of the item associated with this item line. This field cannot be
|
|
2432
|
+
* cleared.
|
|
2433
|
+
*
|
|
2434
|
+
* **NOTE**: Do not use this field if the associated item is a discount item.
|
|
2435
|
+
*/
|
|
2436
|
+
quantity?: number;
|
|
2437
|
+
/**
|
|
2438
|
+
* The item line's sales representative. Sales representatives can be employees,
|
|
2439
|
+
* vendors, or other names in QuickBooks.
|
|
2440
|
+
*/
|
|
2441
|
+
salesRepresentativeId?: string;
|
|
2442
|
+
/**
|
|
2443
|
+
* The sales-tax code for this item line, determining whether it is taxable or
|
|
2444
|
+
* non-taxable. If set, this overrides any sales-tax codes defined on the parent
|
|
2445
|
+
* transaction or the associated item.
|
|
2446
|
+
*
|
|
2447
|
+
* Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
|
|
2448
|
+
* can also be created in QuickBooks. If QuickBooks is not set up to charge sales
|
|
2449
|
+
* tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
|
|
2450
|
+
* non-taxable code to all sales.
|
|
2451
|
+
*/
|
|
2452
|
+
salesTaxCodeId?: string;
|
|
2453
|
+
/**
|
|
2454
|
+
* The serial number of the item associated with this item line. This is used for
|
|
2455
|
+
* tracking individual units of serialized inventory items.
|
|
2456
|
+
*/
|
|
2457
|
+
serialNumber?: string;
|
|
2458
|
+
/**
|
|
2459
|
+
* The unit-of-measure used for the `quantity` in this item line. Must be a valid
|
|
2460
|
+
* unit within the item's available units of measure.
|
|
2461
|
+
*/
|
|
2462
|
+
unitOfMeasure?: string;
|
|
2463
|
+
}
|
|
2464
|
+
}
|
|
2465
|
+
export interface CheckListParams extends CursorPageParams {
|
|
2466
|
+
/**
|
|
2467
|
+
* Header param: The ID of the End-User to receive this request.
|
|
2468
|
+
*/
|
|
2469
|
+
conductorEndUserId: string;
|
|
2470
|
+
/**
|
|
2471
|
+
* Query param: Filter for checks associated with these accounts.
|
|
2472
|
+
*/
|
|
2473
|
+
accountIds?: Array<string>;
|
|
2474
|
+
/**
|
|
2475
|
+
* Query param: Filter for checks in these currencies.
|
|
2476
|
+
*/
|
|
2477
|
+
currencyIds?: Array<string>;
|
|
2478
|
+
/**
|
|
2479
|
+
* Query param: Filter for specific checks by their QuickBooks-assigned unique
|
|
2480
|
+
* identifier(s).
|
|
2481
|
+
*
|
|
2482
|
+
* **IMPORTANT**: If you include this parameter, QuickBooks will ignore all other
|
|
2483
|
+
* query parameters for this request.
|
|
2484
|
+
*
|
|
2485
|
+
* **NOTE**: If any of the values you specify in this parameter are not found, the
|
|
2486
|
+
* request will return an error.
|
|
2487
|
+
*/
|
|
2488
|
+
ids?: Array<string>;
|
|
2489
|
+
/**
|
|
2490
|
+
* Query param: Whether to include line items in the response. Defaults to `true`.
|
|
2491
|
+
*/
|
|
2492
|
+
includeLineItems?: boolean;
|
|
2493
|
+
/**
|
|
2494
|
+
* Query param: Whether to include linked transactions in the response. Defaults to
|
|
2495
|
+
* `false`. For example, a payment linked to the corresponding check.
|
|
2496
|
+
*/
|
|
2497
|
+
includeLinkedTransactions?: boolean;
|
|
2498
|
+
/**
|
|
2499
|
+
* Query param: Filter for checks addressed to these payees. These are the people
|
|
2500
|
+
* or companies who will receive these checks.
|
|
2501
|
+
*/
|
|
2502
|
+
payeeIds?: Array<string>;
|
|
2503
|
+
/**
|
|
2504
|
+
* Query param: Filter for checks whose `refNumber` contains this substring. (For
|
|
2505
|
+
* checks, this field is the check number.)
|
|
2506
|
+
*
|
|
2507
|
+
* **NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith`
|
|
2508
|
+
* or `refNumberEndsWith`.
|
|
2509
|
+
*/
|
|
2510
|
+
refNumberContains?: string;
|
|
2511
|
+
/**
|
|
2512
|
+
* Query param: Filter for checks whose `refNumber` ends with this substring. (For
|
|
2513
|
+
* checks, this field is the check number.)
|
|
2514
|
+
*
|
|
2515
|
+
* **NOTE**: If you use this parameter, you cannot also use `refNumberContains` or
|
|
2516
|
+
* `refNumberStartsWith`.
|
|
2517
|
+
*/
|
|
2518
|
+
refNumberEndsWith?: string;
|
|
2519
|
+
/**
|
|
2520
|
+
* Query param: Filter for checks whose `refNumber` is greater than or equal to
|
|
2521
|
+
* this value. (For checks, this field is the check number.) If omitted, the range
|
|
2522
|
+
* will begin with the first number of the list. Uses a numerical comparison for
|
|
2523
|
+
* values that contain only digits; otherwise, uses a lexicographical comparison.
|
|
2524
|
+
*/
|
|
2525
|
+
refNumberFrom?: string;
|
|
2526
|
+
/**
|
|
2527
|
+
* Query param: Filter for specific checks by their ref-number(s), case-sensitive.
|
|
2528
|
+
* In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily
|
|
2529
|
+
* changed by the QuickBooks user.
|
|
2530
|
+
*
|
|
2531
|
+
* **IMPORTANT**: If you include this parameter, QuickBooks will ignore all other
|
|
2532
|
+
* query parameters for this request.
|
|
2533
|
+
*
|
|
2534
|
+
* **NOTE**: If any of the values you specify in this parameter are not found, the
|
|
2535
|
+
* request will return an error.
|
|
2536
|
+
*/
|
|
2537
|
+
refNumbers?: Array<string>;
|
|
2538
|
+
/**
|
|
2539
|
+
* Query param: Filter for checks whose `refNumber` starts with this substring.
|
|
2540
|
+
* (For checks, this field is the check number.)
|
|
2541
|
+
*
|
|
2542
|
+
* **NOTE**: If you use this parameter, you cannot also use `refNumberContains` or
|
|
2543
|
+
* `refNumberEndsWith`.
|
|
2544
|
+
*/
|
|
2545
|
+
refNumberStartsWith?: string;
|
|
2546
|
+
/**
|
|
2547
|
+
* Query param: Filter for checks whose `refNumber` is less than or equal to this
|
|
2548
|
+
* value. (For checks, this field is the check number.) If omitted, the range will
|
|
2549
|
+
* end with the last number of the list. Uses a numerical comparison for values
|
|
2550
|
+
* that contain only digits; otherwise, uses a lexicographical comparison.
|
|
2551
|
+
*/
|
|
2552
|
+
refNumberTo?: string;
|
|
2553
|
+
/**
|
|
2554
|
+
* Query param: Filter for checks whose `date` field is on or after this date, in
|
|
2555
|
+
* ISO 8601 format (YYYY-MM-DD).
|
|
2556
|
+
*
|
|
2557
|
+
* **NOTE:** QuickBooks Desktop interprets this date as the **start of the
|
|
2558
|
+
* specified day** in the local timezone of the end-user's computer (e.g.,
|
|
2559
|
+
* `2025-01-01` → `2025-01-01T00:00:00`).
|
|
2560
|
+
*/
|
|
2561
|
+
transactionDateFrom?: string;
|
|
2562
|
+
/**
|
|
2563
|
+
* Query param: Filter for checks whose `date` field is on or before this date, in
|
|
2564
|
+
* ISO 8601 format (YYYY-MM-DD).
|
|
2565
|
+
*
|
|
2566
|
+
* **NOTE:** QuickBooks Desktop interprets this date as the **end of the specified
|
|
2567
|
+
* day** in the local timezone of the end-user's computer (e.g., `2025-01-01` →
|
|
2568
|
+
* `2025-01-01T23:59:59`).
|
|
2569
|
+
*/
|
|
2570
|
+
transactionDateTo?: string;
|
|
2571
|
+
/**
|
|
2572
|
+
* Query param: Filter for checks updated on or after this date/time. Accepts the
|
|
2573
|
+
* following ISO 8601 formats:
|
|
2574
|
+
*
|
|
2575
|
+
* - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the
|
|
2576
|
+
* **start of the specified day** in the local timezone of the end-user's
|
|
2577
|
+
* computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).
|
|
2578
|
+
* - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop
|
|
2579
|
+
* interprets the timestamp in the local timezone of the end-user's computer.
|
|
2580
|
+
* - **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop
|
|
2581
|
+
* interprets the timestamp using the specified timezone.
|
|
2582
|
+
*/
|
|
2583
|
+
updatedAfter?: string;
|
|
2584
|
+
/**
|
|
2585
|
+
* Query param: Filter for checks updated on or before this date/time. Accepts the
|
|
2586
|
+
* following ISO 8601 formats:
|
|
2587
|
+
*
|
|
2588
|
+
* - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the
|
|
2589
|
+
* **end of the specified day** in the local timezone of the end-user's computer
|
|
2590
|
+
* (e.g., `2025-01-01` → `2025-01-01T23:59:59`).
|
|
2591
|
+
* - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop
|
|
2592
|
+
* interprets the timestamp in the local timezone of the end-user's computer.
|
|
2593
|
+
* - **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop
|
|
2594
|
+
* interprets the timestamp using the specified timezone.
|
|
2595
|
+
*/
|
|
2596
|
+
updatedBefore?: string;
|
|
2597
|
+
}
|
|
2598
|
+
export interface CheckDeleteParams {
|
|
2599
|
+
/**
|
|
2600
|
+
* The ID of the End-User to receive this request.
|
|
2601
|
+
*/
|
|
2602
|
+
conductorEndUserId: string;
|
|
2603
|
+
}
|
|
2604
|
+
export declare namespace Checks {
|
|
2605
|
+
export { type Check as Check, type CheckDeleteResponse as CheckDeleteResponse, type ChecksCursorPage as ChecksCursorPage, type CheckCreateParams as CheckCreateParams, type CheckRetrieveParams as CheckRetrieveParams, type CheckUpdateParams as CheckUpdateParams, type CheckListParams as CheckListParams, type CheckDeleteParams as CheckDeleteParams, };
|
|
2606
|
+
}
|
|
2607
|
+
//# sourceMappingURL=checks.d.mts.map
|