conductor-node 12.42.0 → 13.0.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 +41 -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 +24 -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 +267 -0
- package/resources/qbd/payroll-wage-items.d.mts.map +1 -0
- package/resources/qbd/payroll-wage-items.d.ts +12 -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 +27 -24
- 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 +35 -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 +21 -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 +41 -41
- 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,3454 @@
|
|
|
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 SalesReceipts extends APIResource {
|
|
6
|
+
/**
|
|
7
|
+
* Creates a sales receipt for a sale paid in full. If you include credit card
|
|
8
|
+
* transaction details, QuickBooks requires the payment method to reference a
|
|
9
|
+
* credit card type and automatically deposits the funds to Undeposited Funds
|
|
10
|
+
* rather than a specific bank account.
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* ```ts
|
|
14
|
+
* const salesReceipt =
|
|
15
|
+
* await conductor.qbd.salesReceipts.create({
|
|
16
|
+
* transactionDate: '2024-10-01',
|
|
17
|
+
* conductorEndUserId: 'end_usr_1234567abcdefg',
|
|
18
|
+
* });
|
|
19
|
+
* ```
|
|
20
|
+
*/
|
|
21
|
+
create(params: SalesReceiptCreateParams, options?: RequestOptions): APIPromise<SalesReceipt>;
|
|
22
|
+
/**
|
|
23
|
+
* Retrieves a sales receipt by ID.
|
|
24
|
+
*
|
|
25
|
+
* **IMPORTANT:** If you need to fetch multiple specific sales receipts by ID, use
|
|
26
|
+
* the list endpoint instead with the `ids` parameter. It accepts an array of IDs
|
|
27
|
+
* so you can batch the request into a single call, which is significantly faster.
|
|
28
|
+
*
|
|
29
|
+
* @example
|
|
30
|
+
* ```ts
|
|
31
|
+
* const salesReceipt =
|
|
32
|
+
* await conductor.qbd.salesReceipts.retrieve(
|
|
33
|
+
* '123ABC-1234567890',
|
|
34
|
+
* { conductorEndUserId: 'end_usr_1234567abcdefg' },
|
|
35
|
+
* );
|
|
36
|
+
* ```
|
|
37
|
+
*/
|
|
38
|
+
retrieve(id: string, params: SalesReceiptRetrieveParams, options?: RequestOptions): APIPromise<SalesReceipt>;
|
|
39
|
+
/**
|
|
40
|
+
* Updates an existing sales receipt. Credit card payments still have to use a
|
|
41
|
+
* credit-card payment method and remain deposited to Undeposited Funds, so don’t
|
|
42
|
+
* switch the deposit account in those scenarios.
|
|
43
|
+
*
|
|
44
|
+
* @example
|
|
45
|
+
* ```ts
|
|
46
|
+
* const salesReceipt =
|
|
47
|
+
* await conductor.qbd.salesReceipts.update(
|
|
48
|
+
* '123ABC-1234567890',
|
|
49
|
+
* {
|
|
50
|
+
* revisionNumber: '1721172183',
|
|
51
|
+
* conductorEndUserId: 'end_usr_1234567abcdefg',
|
|
52
|
+
* },
|
|
53
|
+
* );
|
|
54
|
+
* ```
|
|
55
|
+
*/
|
|
56
|
+
update(id: string, params: SalesReceiptUpdateParams, options?: RequestOptions): APIPromise<SalesReceipt>;
|
|
57
|
+
/**
|
|
58
|
+
* Returns a list of sales receipts. Use the `cursor` parameter to paginate through
|
|
59
|
+
* the results.
|
|
60
|
+
*
|
|
61
|
+
* @example
|
|
62
|
+
* ```ts
|
|
63
|
+
* // Automatically fetches more pages as needed.
|
|
64
|
+
* for await (const salesReceipt of conductor.qbd.salesReceipts.list(
|
|
65
|
+
* { conductorEndUserId: 'end_usr_1234567abcdefg' },
|
|
66
|
+
* )) {
|
|
67
|
+
* // ...
|
|
68
|
+
* }
|
|
69
|
+
* ```
|
|
70
|
+
*/
|
|
71
|
+
list(params: SalesReceiptListParams, options?: RequestOptions): PagePromise<SalesReceiptsCursorPage, SalesReceipt>;
|
|
72
|
+
/**
|
|
73
|
+
* Permanently deletes a a sales receipt. The deletion will fail if the sales
|
|
74
|
+
* receipt is currently in use or has any linked transactions that are in use.
|
|
75
|
+
*
|
|
76
|
+
* @example
|
|
77
|
+
* ```ts
|
|
78
|
+
* const salesReceipt =
|
|
79
|
+
* await conductor.qbd.salesReceipts.delete(
|
|
80
|
+
* '123ABC-1234567890',
|
|
81
|
+
* { conductorEndUserId: 'end_usr_1234567abcdefg' },
|
|
82
|
+
* );
|
|
83
|
+
* ```
|
|
84
|
+
*/
|
|
85
|
+
delete(id: string, params: SalesReceiptDeleteParams, options?: RequestOptions): APIPromise<SalesReceiptDeleteResponse>;
|
|
86
|
+
}
|
|
87
|
+
export type SalesReceiptsCursorPage = CursorPage<SalesReceipt>;
|
|
88
|
+
export interface SalesReceipt {
|
|
89
|
+
/**
|
|
90
|
+
* The unique identifier assigned by QuickBooks to this sales receipt. This ID is
|
|
91
|
+
* unique across all transaction types.
|
|
92
|
+
*/
|
|
93
|
+
id: string;
|
|
94
|
+
/**
|
|
95
|
+
* The sales receipt's billing address.
|
|
96
|
+
*/
|
|
97
|
+
billingAddress: SalesReceipt.BillingAddress | null;
|
|
98
|
+
/**
|
|
99
|
+
* The check number of a check received for this sales receipt.
|
|
100
|
+
*/
|
|
101
|
+
checkNumber: string | null;
|
|
102
|
+
/**
|
|
103
|
+
* The sales receipt's class. Classes can be used to categorize objects into
|
|
104
|
+
* meaningful segments, such as department, location, or type of work. In
|
|
105
|
+
* QuickBooks, class tracking is off by default. A class defined here is
|
|
106
|
+
* automatically used in this sales receipt's line items unless overridden at the
|
|
107
|
+
* line item level.
|
|
108
|
+
*/
|
|
109
|
+
class: SalesReceipt.Class | null;
|
|
110
|
+
/**
|
|
111
|
+
* The date and time when this sales receipt was created, in ISO 8601 format
|
|
112
|
+
* (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local
|
|
113
|
+
* timezone of the end-user's computer.
|
|
114
|
+
*/
|
|
115
|
+
createdAt: string;
|
|
116
|
+
/**
|
|
117
|
+
* The credit card transaction data for this sales receipt's payment when using
|
|
118
|
+
* QuickBooks Merchant Services (QBMS).
|
|
119
|
+
*/
|
|
120
|
+
creditCardTransaction: SalesReceipt.CreditCardTransaction | null;
|
|
121
|
+
/**
|
|
122
|
+
* The sales receipt's currency. For built-in currencies, the name and code are
|
|
123
|
+
* standard international values. For user-defined currencies, all values are
|
|
124
|
+
* editable.
|
|
125
|
+
*/
|
|
126
|
+
currency: SalesReceipt.Currency | null;
|
|
127
|
+
/**
|
|
128
|
+
* The customer or customer-job to which the payment for this sales receipt is
|
|
129
|
+
* credited.
|
|
130
|
+
*/
|
|
131
|
+
customer: SalesReceipt.Customer | null;
|
|
132
|
+
/**
|
|
133
|
+
* The message to display to the customer on the sales receipt.
|
|
134
|
+
*/
|
|
135
|
+
customerMessage: SalesReceipt.CustomerMessage | null;
|
|
136
|
+
/**
|
|
137
|
+
* The custom fields for the sales receipt object, added as user-defined data
|
|
138
|
+
* extensions, not included in the standard QuickBooks object.
|
|
139
|
+
*/
|
|
140
|
+
customFields: Array<SalesReceipt.CustomField>;
|
|
141
|
+
/**
|
|
142
|
+
* The account where the funds for this sales receipt will be or have been
|
|
143
|
+
* deposited.
|
|
144
|
+
*/
|
|
145
|
+
depositToAccount: SalesReceipt.DepositToAccount | null;
|
|
146
|
+
/**
|
|
147
|
+
* The predefined template in QuickBooks that determines the layout and formatting
|
|
148
|
+
* for this sales receipt when printed or displayed.
|
|
149
|
+
*/
|
|
150
|
+
documentTemplate: SalesReceipt.DocumentTemplate | null;
|
|
151
|
+
/**
|
|
152
|
+
* The date by which this sales receipt must be paid, in ISO 8601 format
|
|
153
|
+
* (YYYY-MM-DD).
|
|
154
|
+
*
|
|
155
|
+
* **NOTE**: For sales receipts, this field is often `null` because sales receipts
|
|
156
|
+
* are generally used for point-of-sale payments, where full payment is received at
|
|
157
|
+
* the time of purchase.
|
|
158
|
+
*/
|
|
159
|
+
dueDate: string | null;
|
|
160
|
+
/**
|
|
161
|
+
* The market exchange rate between this sales receipt's currency and the home
|
|
162
|
+
* currency in QuickBooks at the time of this transaction. Represented as a decimal
|
|
163
|
+
* value (e.g., 1.2345 for 1 EUR = 1.2345 USD if USD is the home currency).
|
|
164
|
+
*/
|
|
165
|
+
exchangeRate: number | null;
|
|
166
|
+
/**
|
|
167
|
+
* A globally unique identifier (GUID) you, the developer, can provide for tracking
|
|
168
|
+
* this object in your external system. This field is immutable and can only be set
|
|
169
|
+
* during object creation.
|
|
170
|
+
*/
|
|
171
|
+
externalId: string | null;
|
|
172
|
+
/**
|
|
173
|
+
* Indicates whether this sales receipt has not been completed.
|
|
174
|
+
*/
|
|
175
|
+
isPending: boolean | null;
|
|
176
|
+
/**
|
|
177
|
+
* Indicates whether this sales receipt is included in the queue of documents for
|
|
178
|
+
* QuickBooks to email to the customer.
|
|
179
|
+
*/
|
|
180
|
+
isQueuedForEmail: boolean | null;
|
|
181
|
+
/**
|
|
182
|
+
* Indicates whether this sales receipt is included in the queue of documents for
|
|
183
|
+
* QuickBooks to print.
|
|
184
|
+
*/
|
|
185
|
+
isQueuedForPrint: boolean | null;
|
|
186
|
+
/**
|
|
187
|
+
* The sales receipt's line item groups, each representing a predefined set of
|
|
188
|
+
* related items.
|
|
189
|
+
*/
|
|
190
|
+
lineGroups: Array<SalesReceipt.LineGroup>;
|
|
191
|
+
/**
|
|
192
|
+
* The sales receipt's line items, each representing a single product or service
|
|
193
|
+
* sold.
|
|
194
|
+
*/
|
|
195
|
+
lines: Array<SalesReceipt.Line>;
|
|
196
|
+
/**
|
|
197
|
+
* A memo or note for this sales receipt that appears in reports, but not on the
|
|
198
|
+
* sales receipt.
|
|
199
|
+
*/
|
|
200
|
+
memo: string | null;
|
|
201
|
+
/**
|
|
202
|
+
* The type of object. This value is always `"qbd_sales_receipt"`.
|
|
203
|
+
*/
|
|
204
|
+
objectType: 'qbd_sales_receipt';
|
|
205
|
+
/**
|
|
206
|
+
* A built-in custom field for additional information specific to this sales
|
|
207
|
+
* receipt. Unlike the user-defined fields in the `customFields` array, this is a
|
|
208
|
+
* standard QuickBooks field that exists for all sales receipts for convenience.
|
|
209
|
+
* Developers often use this field for tracking information that doesn't fit into
|
|
210
|
+
* other standard QuickBooks fields. Unlike `otherCustomField1` and
|
|
211
|
+
* `otherCustomField2`, which are line item fields, this exists at the transaction
|
|
212
|
+
* level. Hidden by default in the QuickBooks UI.
|
|
213
|
+
*/
|
|
214
|
+
otherCustomField: string | null;
|
|
215
|
+
/**
|
|
216
|
+
* The sales receipt's payment method (e.g., cash, check, credit card).
|
|
217
|
+
*/
|
|
218
|
+
paymentMethod: SalesReceipt.PaymentMethod | null;
|
|
219
|
+
/**
|
|
220
|
+
* The case-sensitive user-defined reference number for this sales receipt, which
|
|
221
|
+
* can be used to identify the transaction in QuickBooks. This value is not
|
|
222
|
+
* required to be unique and can be arbitrarily changed by the QuickBooks user.
|
|
223
|
+
*/
|
|
224
|
+
refNumber: string | null;
|
|
225
|
+
/**
|
|
226
|
+
* The current QuickBooks-assigned revision number of this sales receipt object,
|
|
227
|
+
* which changes each time the object is modified. When updating this object, you
|
|
228
|
+
* must provide the most recent `revisionNumber` to ensure you're working with the
|
|
229
|
+
* latest data; otherwise, the update will return an error.
|
|
230
|
+
*/
|
|
231
|
+
revisionNumber: string;
|
|
232
|
+
/**
|
|
233
|
+
* The sales receipt's sales representative. Sales representatives can be
|
|
234
|
+
* employees, vendors, or other names in QuickBooks.
|
|
235
|
+
*/
|
|
236
|
+
salesRepresentative: SalesReceipt.SalesRepresentative | null;
|
|
237
|
+
/**
|
|
238
|
+
* The sales-tax code for this sales receipt, determining whether it is taxable or
|
|
239
|
+
* non-taxable. This can be overridden at the transaction-line level.
|
|
240
|
+
*
|
|
241
|
+
* Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
|
|
242
|
+
* can also be created in QuickBooks. If QuickBooks is not set up to charge sales
|
|
243
|
+
* tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
|
|
244
|
+
* non-taxable code to all sales.
|
|
245
|
+
*/
|
|
246
|
+
salesTaxCode: SalesReceipt.SalesTaxCode | null;
|
|
247
|
+
/**
|
|
248
|
+
* The sales-tax item used to calculate the actual tax amount for this sales
|
|
249
|
+
* receipt's transactions by applying a specific tax rate collected for a single
|
|
250
|
+
* tax agency. Unlike `salesTaxCode`, which only indicates general taxability, this
|
|
251
|
+
* field drives the actual tax calculation and reporting.
|
|
252
|
+
*
|
|
253
|
+
* For sales receipts, while using this field to specify a single tax item/group
|
|
254
|
+
* that applies uniformly is recommended, complex tax scenarios may require
|
|
255
|
+
* alternative approaches. In such cases, you can set this field to a 0% tax item
|
|
256
|
+
* (conventionally named "Tax Calculated On Invoice") and handle tax calculations
|
|
257
|
+
* through line items instead. When using line items for taxes, note that only
|
|
258
|
+
* individual tax items (not tax groups) can be used, subtotals can help apply a
|
|
259
|
+
* tax to multiple items but only the first tax line after a subtotal is calculated
|
|
260
|
+
* automatically (subsequent tax lines require manual amounts), and the rate column
|
|
261
|
+
* will always display the actual tax amount rather than the rate percentage.
|
|
262
|
+
*/
|
|
263
|
+
salesTaxItem: SalesReceipt.SalesTaxItem | null;
|
|
264
|
+
/**
|
|
265
|
+
* The sales tax percentage applied to this sales receipt, represented as a decimal
|
|
266
|
+
* string.
|
|
267
|
+
*/
|
|
268
|
+
salesTaxPercentage: string | null;
|
|
269
|
+
/**
|
|
270
|
+
* The total amount of sales tax charged for this sales receipt, represented as a
|
|
271
|
+
* decimal string.
|
|
272
|
+
*/
|
|
273
|
+
salesTaxTotal: string | null;
|
|
274
|
+
/**
|
|
275
|
+
* The origin location from where the product associated with this sales receipt is
|
|
276
|
+
* shipped. This is the point at which ownership and liability for goods transfer
|
|
277
|
+
* from seller to buyer. Internally, QuickBooks uses the term "FOB" for this field,
|
|
278
|
+
* which stands for "freight on board". This field is informational and has no
|
|
279
|
+
* accounting implications.
|
|
280
|
+
*/
|
|
281
|
+
shipmentOrigin: string | null;
|
|
282
|
+
/**
|
|
283
|
+
* The sales receipt's shipping address.
|
|
284
|
+
*/
|
|
285
|
+
shippingAddress: SalesReceipt.ShippingAddress | null;
|
|
286
|
+
/**
|
|
287
|
+
* The date when the products or services for this sales receipt were shipped or
|
|
288
|
+
* are expected to be shipped, in ISO 8601 format (YYYY-MM-DD).
|
|
289
|
+
*/
|
|
290
|
+
shippingDate: string | null;
|
|
291
|
+
/**
|
|
292
|
+
* The shipping method used for this sales receipt, such as standard mail or
|
|
293
|
+
* overnight delivery.
|
|
294
|
+
*/
|
|
295
|
+
shippingMethod: SalesReceipt.ShippingMethod | null;
|
|
296
|
+
/**
|
|
297
|
+
* The subtotal of this sales receipt, which is the sum of all sales receipt lines
|
|
298
|
+
* before taxes and payments are applied, represented as a decimal string.
|
|
299
|
+
*/
|
|
300
|
+
subtotal: string;
|
|
301
|
+
/**
|
|
302
|
+
* The total monetary amount of this sales receipt, equivalent to the sum of the
|
|
303
|
+
* amounts in `lines` and `lineGroups`, represented as a decimal string.
|
|
304
|
+
*/
|
|
305
|
+
totalAmount: string;
|
|
306
|
+
/**
|
|
307
|
+
* The total monetary amount of this sales receipt converted to the home currency
|
|
308
|
+
* of the QuickBooks company file. Represented as a decimal string.
|
|
309
|
+
*/
|
|
310
|
+
totalAmountInHomeCurrency: string | null;
|
|
311
|
+
/**
|
|
312
|
+
* The date of this sales receipt, in ISO 8601 format (YYYY-MM-DD).
|
|
313
|
+
*/
|
|
314
|
+
transactionDate: string;
|
|
315
|
+
/**
|
|
316
|
+
* The date and time when this sales receipt was last updated, in ISO 8601 format
|
|
317
|
+
* (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local
|
|
318
|
+
* timezone of the end-user's computer.
|
|
319
|
+
*/
|
|
320
|
+
updatedAt: string;
|
|
321
|
+
}
|
|
322
|
+
export declare namespace SalesReceipt {
|
|
323
|
+
/**
|
|
324
|
+
* The sales receipt's billing address.
|
|
325
|
+
*/
|
|
326
|
+
interface BillingAddress {
|
|
327
|
+
/**
|
|
328
|
+
* The city, district, suburb, town, or village name of the address.
|
|
329
|
+
*/
|
|
330
|
+
city: string | null;
|
|
331
|
+
/**
|
|
332
|
+
* The country name of the address.
|
|
333
|
+
*/
|
|
334
|
+
country: string | null;
|
|
335
|
+
/**
|
|
336
|
+
* The first line of the address (e.g., street, PO Box, or company name).
|
|
337
|
+
*/
|
|
338
|
+
line1: string | null;
|
|
339
|
+
/**
|
|
340
|
+
* The second line of the address, if needed (e.g., apartment, suite, unit, or
|
|
341
|
+
* building).
|
|
342
|
+
*/
|
|
343
|
+
line2: string | null;
|
|
344
|
+
/**
|
|
345
|
+
* The third line of the address, if needed.
|
|
346
|
+
*/
|
|
347
|
+
line3: string | null;
|
|
348
|
+
/**
|
|
349
|
+
* The fourth line of the address, if needed.
|
|
350
|
+
*/
|
|
351
|
+
line4: string | null;
|
|
352
|
+
/**
|
|
353
|
+
* The fifth line of the address, if needed.
|
|
354
|
+
*/
|
|
355
|
+
line5: string | null;
|
|
356
|
+
/**
|
|
357
|
+
* A note written at the bottom of the address in the form in which it appears,
|
|
358
|
+
* such as the invoice form.
|
|
359
|
+
*/
|
|
360
|
+
note: string | null;
|
|
361
|
+
/**
|
|
362
|
+
* The postal code or ZIP code of the address.
|
|
363
|
+
*/
|
|
364
|
+
postalCode: string | null;
|
|
365
|
+
/**
|
|
366
|
+
* The state, county, province, or region name of the address.
|
|
367
|
+
*/
|
|
368
|
+
state: string | null;
|
|
369
|
+
}
|
|
370
|
+
/**
|
|
371
|
+
* The sales receipt's class. Classes can be used to categorize objects into
|
|
372
|
+
* meaningful segments, such as department, location, or type of work. In
|
|
373
|
+
* QuickBooks, class tracking is off by default. A class defined here is
|
|
374
|
+
* automatically used in this sales receipt's line items unless overridden at the
|
|
375
|
+
* line item level.
|
|
376
|
+
*/
|
|
377
|
+
interface Class {
|
|
378
|
+
/**
|
|
379
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
380
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
381
|
+
* types.
|
|
382
|
+
*/
|
|
383
|
+
id: string | null;
|
|
384
|
+
/**
|
|
385
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
386
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
387
|
+
* case-sensitive.
|
|
388
|
+
*/
|
|
389
|
+
fullName: string | null;
|
|
390
|
+
}
|
|
391
|
+
/**
|
|
392
|
+
* The credit card transaction data for this sales receipt's payment when using
|
|
393
|
+
* QuickBooks Merchant Services (QBMS).
|
|
394
|
+
*/
|
|
395
|
+
interface CreditCardTransaction {
|
|
396
|
+
/**
|
|
397
|
+
* The transaction request data originally supplied for this credit card
|
|
398
|
+
* transaction when using QuickBooks Merchant Services (QBMS).
|
|
399
|
+
*/
|
|
400
|
+
request: CreditCardTransaction.Request | null;
|
|
401
|
+
/**
|
|
402
|
+
* The transaction response data for this credit card transaction when using
|
|
403
|
+
* QuickBooks Merchant Services (QBMS).
|
|
404
|
+
*/
|
|
405
|
+
response: CreditCardTransaction.Response | null;
|
|
406
|
+
}
|
|
407
|
+
namespace CreditCardTransaction {
|
|
408
|
+
/**
|
|
409
|
+
* The transaction request data originally supplied for this credit card
|
|
410
|
+
* transaction when using QuickBooks Merchant Services (QBMS).
|
|
411
|
+
*/
|
|
412
|
+
interface Request {
|
|
413
|
+
/**
|
|
414
|
+
* The card's billing address.
|
|
415
|
+
*/
|
|
416
|
+
address: string | null;
|
|
417
|
+
/**
|
|
418
|
+
* The commercial card code identifies the type of business credit card being used
|
|
419
|
+
* (purchase, corporate, or business) for Visa and Mastercard transactions only.
|
|
420
|
+
* When provided, this code may qualify the transaction for lower processing fees
|
|
421
|
+
* compared to the standard rates that apply when no code is specified.
|
|
422
|
+
*/
|
|
423
|
+
commercialCardCode: string | null;
|
|
424
|
+
/**
|
|
425
|
+
* The month when the credit card expires.
|
|
426
|
+
*/
|
|
427
|
+
expirationMonth: number;
|
|
428
|
+
/**
|
|
429
|
+
* The year when the credit card expires.
|
|
430
|
+
*/
|
|
431
|
+
expirationYear: number;
|
|
432
|
+
/**
|
|
433
|
+
* The cardholder's name on the card.
|
|
434
|
+
*/
|
|
435
|
+
name: string | null;
|
|
436
|
+
/**
|
|
437
|
+
* The credit card number. Must be masked with lower case "x" and no dashes.
|
|
438
|
+
*/
|
|
439
|
+
number: string;
|
|
440
|
+
/**
|
|
441
|
+
* The card's billing address ZIP or postal code.
|
|
442
|
+
*/
|
|
443
|
+
postalCode: string | null;
|
|
444
|
+
/**
|
|
445
|
+
* Indicates whether this credit card transaction came from a card swipe
|
|
446
|
+
* (`card_present`) or not (`card_not_present`).
|
|
447
|
+
*/
|
|
448
|
+
transactionMode: 'card_not_present' | 'card_present' | null;
|
|
449
|
+
/**
|
|
450
|
+
* The QBMS transaction type from which the current transaction data originated.
|
|
451
|
+
*/
|
|
452
|
+
transactionType: 'authorization' | 'capture' | 'charge' | 'refund' | 'voice_authorization' | null;
|
|
453
|
+
}
|
|
454
|
+
/**
|
|
455
|
+
* The transaction response data for this credit card transaction when using
|
|
456
|
+
* QuickBooks Merchant Services (QBMS).
|
|
457
|
+
*/
|
|
458
|
+
interface Response {
|
|
459
|
+
/**
|
|
460
|
+
* The authorization code returned from the credit card processor to indicate that
|
|
461
|
+
* this charge will be paid by the card issuer.
|
|
462
|
+
*/
|
|
463
|
+
authorizationCode: string | null;
|
|
464
|
+
/**
|
|
465
|
+
* Indicates whether the street address supplied in the transaction request matches
|
|
466
|
+
* the customer's address on file at the card issuer.
|
|
467
|
+
*/
|
|
468
|
+
avsStreetStatus: 'fail' | 'not_available' | 'pass' | null;
|
|
469
|
+
/**
|
|
470
|
+
* Indicates whether the customer postal ZIP code supplied in the transaction
|
|
471
|
+
* request matches the customer's postal code recognized at the card issuer.
|
|
472
|
+
*/
|
|
473
|
+
avsZipStatus: 'fail' | 'not_available' | 'pass' | null;
|
|
474
|
+
/**
|
|
475
|
+
* Indicates whether the card security code supplied in the transaction request
|
|
476
|
+
* matches the card security code recognized for that credit card number at the
|
|
477
|
+
* card issuer.
|
|
478
|
+
*/
|
|
479
|
+
cardSecurityCodeMatch: 'fail' | 'not_available' | 'pass' | null;
|
|
480
|
+
/**
|
|
481
|
+
* A value returned from QBMS transactions for future use by the QuickBooks
|
|
482
|
+
* Reconciliation feature.
|
|
483
|
+
*/
|
|
484
|
+
clientTransactionId: string | null;
|
|
485
|
+
/**
|
|
486
|
+
* The ID returned from the credit card processor for this credit card transaction.
|
|
487
|
+
*/
|
|
488
|
+
creditCardTransactionId: string;
|
|
489
|
+
/**
|
|
490
|
+
* The QBMS account number of the merchant who is running this transaction using
|
|
491
|
+
* the customer's credit card.
|
|
492
|
+
*/
|
|
493
|
+
merchantAccountNumber: string;
|
|
494
|
+
/**
|
|
495
|
+
* An internal code returned by QuickBooks Merchant Services (QBMS) from the
|
|
496
|
+
* transaction request, needed for the QuickBooks reconciliation feature.
|
|
497
|
+
*/
|
|
498
|
+
paymentGroupingCode: number | null;
|
|
499
|
+
/**
|
|
500
|
+
* Indicates whether this credit card transaction is known to have been
|
|
501
|
+
* successfully processed by the card issuer.
|
|
502
|
+
*/
|
|
503
|
+
paymentStatus: 'completed' | 'unknown';
|
|
504
|
+
/**
|
|
505
|
+
* An internal ID returned by QuickBooks Merchant Services (QBMS) from the
|
|
506
|
+
* transaction request, needed for the QuickBooks reconciliation feature.
|
|
507
|
+
*/
|
|
508
|
+
reconBatchId: string | null;
|
|
509
|
+
/**
|
|
510
|
+
* The status code returned in the original QBMS transaction response for this
|
|
511
|
+
* credit card transaction.
|
|
512
|
+
*/
|
|
513
|
+
statusCode: number;
|
|
514
|
+
/**
|
|
515
|
+
* The status message returned in the original QBMS transaction response for this
|
|
516
|
+
* credit card transaction.
|
|
517
|
+
*/
|
|
518
|
+
statusMessage: string;
|
|
519
|
+
/**
|
|
520
|
+
* An internal value for this credit card transaction, needed for the QuickBooks
|
|
521
|
+
* reconciliation feature.
|
|
522
|
+
*/
|
|
523
|
+
transactionAuthorizationStamp: number | null;
|
|
524
|
+
/**
|
|
525
|
+
* The date and time when the credit card processor authorized this credit card
|
|
526
|
+
* transaction.
|
|
527
|
+
*/
|
|
528
|
+
transactionAuthorizedAt: string;
|
|
529
|
+
}
|
|
530
|
+
}
|
|
531
|
+
/**
|
|
532
|
+
* The sales receipt's currency. For built-in currencies, the name and code are
|
|
533
|
+
* standard international values. For user-defined currencies, all values are
|
|
534
|
+
* editable.
|
|
535
|
+
*/
|
|
536
|
+
interface Currency {
|
|
537
|
+
/**
|
|
538
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
539
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
540
|
+
* types.
|
|
541
|
+
*/
|
|
542
|
+
id: string | null;
|
|
543
|
+
/**
|
|
544
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
545
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
546
|
+
* case-sensitive.
|
|
547
|
+
*/
|
|
548
|
+
fullName: string | null;
|
|
549
|
+
}
|
|
550
|
+
/**
|
|
551
|
+
* The customer or customer-job to which the payment for this sales receipt is
|
|
552
|
+
* credited.
|
|
553
|
+
*/
|
|
554
|
+
interface Customer {
|
|
555
|
+
/**
|
|
556
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
557
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
558
|
+
* types.
|
|
559
|
+
*/
|
|
560
|
+
id: string | null;
|
|
561
|
+
/**
|
|
562
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
563
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
564
|
+
* case-sensitive.
|
|
565
|
+
*/
|
|
566
|
+
fullName: string | null;
|
|
567
|
+
}
|
|
568
|
+
/**
|
|
569
|
+
* The message to display to the customer on the sales receipt.
|
|
570
|
+
*/
|
|
571
|
+
interface CustomerMessage {
|
|
572
|
+
/**
|
|
573
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
574
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
575
|
+
* types.
|
|
576
|
+
*/
|
|
577
|
+
id: string | null;
|
|
578
|
+
/**
|
|
579
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
580
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
581
|
+
* case-sensitive.
|
|
582
|
+
*/
|
|
583
|
+
fullName: string | null;
|
|
584
|
+
}
|
|
585
|
+
interface CustomField {
|
|
586
|
+
/**
|
|
587
|
+
* The name of the custom field, unique for the specified `ownerId`. For public
|
|
588
|
+
* custom fields, this name is visible as a label in the QuickBooks UI.
|
|
589
|
+
*/
|
|
590
|
+
name: string;
|
|
591
|
+
/**
|
|
592
|
+
* The identifier of the owner of the custom field, which QuickBooks internally
|
|
593
|
+
* calls a "data extension". For public custom fields visible in the UI, such as
|
|
594
|
+
* those added by the QuickBooks user, this is always "0". For private custom
|
|
595
|
+
* fields that are only visible to the application that created them, this is a
|
|
596
|
+
* valid GUID identifying the owning application. Internally, Conductor always
|
|
597
|
+
* fetches all public custom fields (those with an `ownerId` of "0") for all
|
|
598
|
+
* objects.
|
|
599
|
+
*/
|
|
600
|
+
ownerId: string;
|
|
601
|
+
/**
|
|
602
|
+
* The data type of this custom field.
|
|
603
|
+
*/
|
|
604
|
+
type: 'amount_type' | 'date_time_type' | 'integer_type' | 'percent_type' | 'price_type' | 'quantity_type' | 'string_1024_type' | 'string_255_type';
|
|
605
|
+
/**
|
|
606
|
+
* The value of this custom field. The maximum length depends on the field's data
|
|
607
|
+
* type.
|
|
608
|
+
*/
|
|
609
|
+
value: string;
|
|
610
|
+
}
|
|
611
|
+
/**
|
|
612
|
+
* The account where the funds for this sales receipt will be or have been
|
|
613
|
+
* deposited.
|
|
614
|
+
*/
|
|
615
|
+
interface DepositToAccount {
|
|
616
|
+
/**
|
|
617
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
618
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
619
|
+
* types.
|
|
620
|
+
*/
|
|
621
|
+
id: string | null;
|
|
622
|
+
/**
|
|
623
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
624
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
625
|
+
* case-sensitive.
|
|
626
|
+
*/
|
|
627
|
+
fullName: string | null;
|
|
628
|
+
}
|
|
629
|
+
/**
|
|
630
|
+
* The predefined template in QuickBooks that determines the layout and formatting
|
|
631
|
+
* for this sales receipt when printed or displayed.
|
|
632
|
+
*/
|
|
633
|
+
interface DocumentTemplate {
|
|
634
|
+
/**
|
|
635
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
636
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
637
|
+
* types.
|
|
638
|
+
*/
|
|
639
|
+
id: string | null;
|
|
640
|
+
/**
|
|
641
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
642
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
643
|
+
* case-sensitive.
|
|
644
|
+
*/
|
|
645
|
+
fullName: string | null;
|
|
646
|
+
}
|
|
647
|
+
interface LineGroup {
|
|
648
|
+
/**
|
|
649
|
+
* The unique identifier assigned by QuickBooks to this sales receipt line group.
|
|
650
|
+
* This ID is unique across all transaction line types.
|
|
651
|
+
*/
|
|
652
|
+
id: string;
|
|
653
|
+
/**
|
|
654
|
+
* The custom fields for the sales receipt line group object, added as user-defined
|
|
655
|
+
* data extensions, not included in the standard QuickBooks object.
|
|
656
|
+
*/
|
|
657
|
+
customFields: Array<LineGroup.CustomField>;
|
|
658
|
+
/**
|
|
659
|
+
* A description of this sales receipt line group.
|
|
660
|
+
*/
|
|
661
|
+
description: string | null;
|
|
662
|
+
/**
|
|
663
|
+
* The sales receipt line group's item group, representing a predefined set of
|
|
664
|
+
* items bundled because they are commonly purchased together or grouped for faster
|
|
665
|
+
* entry.
|
|
666
|
+
*/
|
|
667
|
+
itemGroup: LineGroup.ItemGroup;
|
|
668
|
+
/**
|
|
669
|
+
* The sales receipt line group's line items, each representing a single product or
|
|
670
|
+
* service sold.
|
|
671
|
+
*/
|
|
672
|
+
lines: Array<LineGroup.Line>;
|
|
673
|
+
/**
|
|
674
|
+
* The type of object. This value is always `"qbd_sales_receipt_line_group"`.
|
|
675
|
+
*/
|
|
676
|
+
objectType: 'qbd_sales_receipt_line_group';
|
|
677
|
+
/**
|
|
678
|
+
* Specifies an alternative unit-of-measure set when updating this sales receipt
|
|
679
|
+
* line group's `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows
|
|
680
|
+
* you to select units from a different set than the item's default unit-of-measure
|
|
681
|
+
* set, which remains unchanged on the item itself. The override applies only to
|
|
682
|
+
* this specific line. For example, you can sell an item typically measured in
|
|
683
|
+
* volume units using weight units in a specific transaction by specifying a
|
|
684
|
+
* different unit-of-measure set with this field.
|
|
685
|
+
*/
|
|
686
|
+
overrideUnitOfMeasureSet: LineGroup.OverrideUnitOfMeasureSet | null;
|
|
687
|
+
/**
|
|
688
|
+
* The quantity of the item group associated with this sales receipt line group.
|
|
689
|
+
* This field cannot be cleared.
|
|
690
|
+
*
|
|
691
|
+
* **NOTE**: Do not use this field if the associated item group is a discount item
|
|
692
|
+
* group.
|
|
693
|
+
*/
|
|
694
|
+
quantity: number | null;
|
|
695
|
+
/**
|
|
696
|
+
* Indicates whether the individual items in this sales receipt line group and
|
|
697
|
+
* their separate amounts appear on printed forms.
|
|
698
|
+
*/
|
|
699
|
+
shouldPrintItemsInGroup: boolean;
|
|
700
|
+
/**
|
|
701
|
+
* The total monetary amount of this sales receipt line group, equivalent to the
|
|
702
|
+
* sum of the amounts in `lines`, represented as a decimal string.
|
|
703
|
+
*/
|
|
704
|
+
totalAmount: string;
|
|
705
|
+
/**
|
|
706
|
+
* The unit-of-measure used for the `quantity` in this sales receipt line group.
|
|
707
|
+
* Must be a valid unit within the item's available units of measure.
|
|
708
|
+
*/
|
|
709
|
+
unitOfMeasure: string | null;
|
|
710
|
+
}
|
|
711
|
+
namespace LineGroup {
|
|
712
|
+
interface CustomField {
|
|
713
|
+
/**
|
|
714
|
+
* The name of the custom field, unique for the specified `ownerId`. For public
|
|
715
|
+
* custom fields, this name is visible as a label in the QuickBooks UI.
|
|
716
|
+
*/
|
|
717
|
+
name: string;
|
|
718
|
+
/**
|
|
719
|
+
* The identifier of the owner of the custom field, which QuickBooks internally
|
|
720
|
+
* calls a "data extension". For public custom fields visible in the UI, such as
|
|
721
|
+
* those added by the QuickBooks user, this is always "0". For private custom
|
|
722
|
+
* fields that are only visible to the application that created them, this is a
|
|
723
|
+
* valid GUID identifying the owning application. Internally, Conductor always
|
|
724
|
+
* fetches all public custom fields (those with an `ownerId` of "0") for all
|
|
725
|
+
* objects.
|
|
726
|
+
*/
|
|
727
|
+
ownerId: string;
|
|
728
|
+
/**
|
|
729
|
+
* The data type of this custom field.
|
|
730
|
+
*/
|
|
731
|
+
type: 'amount_type' | 'date_time_type' | 'integer_type' | 'percent_type' | 'price_type' | 'quantity_type' | 'string_1024_type' | 'string_255_type';
|
|
732
|
+
/**
|
|
733
|
+
* The value of this custom field. The maximum length depends on the field's data
|
|
734
|
+
* type.
|
|
735
|
+
*/
|
|
736
|
+
value: string;
|
|
737
|
+
}
|
|
738
|
+
/**
|
|
739
|
+
* The sales receipt line group's item group, representing a predefined set of
|
|
740
|
+
* items bundled because they are commonly purchased together or grouped for faster
|
|
741
|
+
* entry.
|
|
742
|
+
*/
|
|
743
|
+
interface ItemGroup {
|
|
744
|
+
/**
|
|
745
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
746
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
747
|
+
* types.
|
|
748
|
+
*/
|
|
749
|
+
id: string | null;
|
|
750
|
+
/**
|
|
751
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
752
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
753
|
+
* case-sensitive.
|
|
754
|
+
*/
|
|
755
|
+
fullName: string | null;
|
|
756
|
+
}
|
|
757
|
+
interface Line {
|
|
758
|
+
/**
|
|
759
|
+
* The unique identifier assigned by QuickBooks to this sales receipt line. This ID
|
|
760
|
+
* is unique across all transaction line types.
|
|
761
|
+
*/
|
|
762
|
+
id: string;
|
|
763
|
+
/**
|
|
764
|
+
* The monetary amount of this sales receipt line, represented as a decimal string.
|
|
765
|
+
* If both `quantity` and `rate` are specified but not `amount`, QuickBooks will
|
|
766
|
+
* use them to calculate `amount`. If `amount`, `rate`, and `quantity` are all
|
|
767
|
+
* unspecified, then QuickBooks will calculate `amount` based on a `quantity` of
|
|
768
|
+
* `1` and the suggested `rate`. This field cannot be cleared.
|
|
769
|
+
*/
|
|
770
|
+
amount: string | null;
|
|
771
|
+
/**
|
|
772
|
+
* The sales receipt line's class. Classes can be used to categorize objects into
|
|
773
|
+
* meaningful segments, such as department, location, or type of work. In
|
|
774
|
+
* QuickBooks, class tracking is off by default. If a class is specified for the
|
|
775
|
+
* entire parent transaction, it is automatically applied to all sales receipt
|
|
776
|
+
* lines unless overridden here, at the transaction line level.
|
|
777
|
+
*/
|
|
778
|
+
class: Line.Class | null;
|
|
779
|
+
/**
|
|
780
|
+
* The credit card transaction data for this sales receipt line's payment when
|
|
781
|
+
* using QuickBooks Merchant Services (QBMS).
|
|
782
|
+
*/
|
|
783
|
+
creditCardTransaction: Line.CreditCardTransaction | null;
|
|
784
|
+
/**
|
|
785
|
+
* The custom fields for the sales receipt line object, added as user-defined data
|
|
786
|
+
* extensions, not included in the standard QuickBooks object.
|
|
787
|
+
*/
|
|
788
|
+
customFields: Array<Line.CustomField>;
|
|
789
|
+
/**
|
|
790
|
+
* A description of this sales receipt line.
|
|
791
|
+
*/
|
|
792
|
+
description: string | null;
|
|
793
|
+
/**
|
|
794
|
+
* The expiration date for the serial number or lot number of the item associated
|
|
795
|
+
* with this sales receipt line, in ISO 8601 format (YYYY-MM-DD). This is
|
|
796
|
+
* particularly relevant for perishable or time-sensitive inventory items. Note
|
|
797
|
+
* that this field is only supported on QuickBooks Desktop 2023 or later.
|
|
798
|
+
*/
|
|
799
|
+
expirationDate: string | null;
|
|
800
|
+
/**
|
|
801
|
+
* The site location where inventory for the item associated with this sales
|
|
802
|
+
* receipt line is stored.
|
|
803
|
+
*/
|
|
804
|
+
inventorySite: Line.InventorySite | null;
|
|
805
|
+
/**
|
|
806
|
+
* The specific location (e.g., bin or shelf) within the inventory site where the
|
|
807
|
+
* item associated with this sales receipt line is stored.
|
|
808
|
+
*/
|
|
809
|
+
inventorySiteLocation: Line.InventorySiteLocation | null;
|
|
810
|
+
/**
|
|
811
|
+
* The item associated with this sales receipt line. This can refer to any good or
|
|
812
|
+
* service that the business buys or sells, including item types such as a service
|
|
813
|
+
* item, inventory item, or special calculation item like a discount item or
|
|
814
|
+
* sales-tax item.
|
|
815
|
+
*/
|
|
816
|
+
item: Line.Item | null;
|
|
817
|
+
/**
|
|
818
|
+
* The lot number of the item associated with this sales receipt line. Used for
|
|
819
|
+
* tracking groups of inventory items that are purchased or manufactured together.
|
|
820
|
+
*/
|
|
821
|
+
lotNumber: string | null;
|
|
822
|
+
/**
|
|
823
|
+
* The type of object. This value is always `"qbd_sales_receipt_line"`.
|
|
824
|
+
*/
|
|
825
|
+
objectType: 'qbd_sales_receipt_line';
|
|
826
|
+
/**
|
|
827
|
+
* A built-in custom field for additional information specific to this sales
|
|
828
|
+
* receipt line. Unlike the user-defined fields in the `customFields` array, this
|
|
829
|
+
* is a standard QuickBooks field that exists for all sales receipt lines for
|
|
830
|
+
* convenience. Developers often use this field for tracking information that
|
|
831
|
+
* doesn't fit into other standard QuickBooks fields. Hidden by default in the
|
|
832
|
+
* QuickBooks UI.
|
|
833
|
+
*/
|
|
834
|
+
otherCustomField1: string | null;
|
|
835
|
+
/**
|
|
836
|
+
* A second built-in custom field for additional information specific to this sales
|
|
837
|
+
* receipt line. Unlike the user-defined fields in the `customFields` array, this
|
|
838
|
+
* is a standard QuickBooks field that exists for all sales receipt lines for
|
|
839
|
+
* convenience. Like `otherCustomField1`, developers often use this field for
|
|
840
|
+
* tracking information that doesn't fit into other standard QuickBooks fields.
|
|
841
|
+
* Hidden by default in the QuickBooks UI.
|
|
842
|
+
*/
|
|
843
|
+
otherCustomField2: string | null;
|
|
844
|
+
/**
|
|
845
|
+
* Specifies an alternative unit-of-measure set when updating this sales receipt
|
|
846
|
+
* line's `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to
|
|
847
|
+
* select units from a different set than the item's default unit-of-measure set,
|
|
848
|
+
* which remains unchanged on the item itself. The override applies only to this
|
|
849
|
+
* specific line. For example, you can sell an item typically measured in volume
|
|
850
|
+
* units using weight units in a specific transaction by specifying a different
|
|
851
|
+
* unit-of-measure set with this field.
|
|
852
|
+
*/
|
|
853
|
+
overrideUnitOfMeasureSet: Line.OverrideUnitOfMeasureSet | null;
|
|
854
|
+
/**
|
|
855
|
+
* The quantity of the item associated with this sales receipt line. This field
|
|
856
|
+
* cannot be cleared.
|
|
857
|
+
*
|
|
858
|
+
* **NOTE**: Do not use this field if the associated item is a discount item.
|
|
859
|
+
*/
|
|
860
|
+
quantity: number | null;
|
|
861
|
+
/**
|
|
862
|
+
* The price per unit for this sales receipt line. If both `rate` and `amount` are
|
|
863
|
+
* specified, `rate` will be ignored. If both `quantity` and `amount` are specified
|
|
864
|
+
* but not `rate`, QuickBooks will use them to calculate `rate`. Represented as a
|
|
865
|
+
* decimal string. This field cannot be cleared.
|
|
866
|
+
*/
|
|
867
|
+
rate: string | null;
|
|
868
|
+
/**
|
|
869
|
+
* The price of this sales receipt line expressed as a percentage. Typically used
|
|
870
|
+
* for discount or markup items.
|
|
871
|
+
*/
|
|
872
|
+
ratePercent: string | null;
|
|
873
|
+
/**
|
|
874
|
+
* The sales-tax code for this sales receipt line, determining whether it is
|
|
875
|
+
* taxable or non-taxable. If set, this overrides any sales-tax codes defined on
|
|
876
|
+
* the parent transaction or the associated item.
|
|
877
|
+
*
|
|
878
|
+
* Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
|
|
879
|
+
* can also be created in QuickBooks. If QuickBooks is not set up to charge sales
|
|
880
|
+
* tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
|
|
881
|
+
* non-taxable code to all sales.
|
|
882
|
+
*/
|
|
883
|
+
salesTaxCode: Line.SalesTaxCode | null;
|
|
884
|
+
/**
|
|
885
|
+
* The serial number of the item associated with this sales receipt line. This is
|
|
886
|
+
* used for tracking individual units of serialized inventory items.
|
|
887
|
+
*/
|
|
888
|
+
serialNumber: string | null;
|
|
889
|
+
/**
|
|
890
|
+
* The date on which the service for this sales receipt line was or will be
|
|
891
|
+
* performed, in ISO 8601 format (YYYY-MM-DD). This is particularly relevant for
|
|
892
|
+
* service items.
|
|
893
|
+
*/
|
|
894
|
+
serviceDate: string | null;
|
|
895
|
+
/**
|
|
896
|
+
* The unit-of-measure used for the `quantity` in this sales receipt line. Must be
|
|
897
|
+
* a valid unit within the item's available units of measure.
|
|
898
|
+
*/
|
|
899
|
+
unitOfMeasure: string | null;
|
|
900
|
+
}
|
|
901
|
+
namespace Line {
|
|
902
|
+
/**
|
|
903
|
+
* The sales receipt line's class. Classes can be used to categorize objects into
|
|
904
|
+
* meaningful segments, such as department, location, or type of work. In
|
|
905
|
+
* QuickBooks, class tracking is off by default. If a class is specified for the
|
|
906
|
+
* entire parent transaction, it is automatically applied to all sales receipt
|
|
907
|
+
* lines unless overridden here, at the transaction line level.
|
|
908
|
+
*/
|
|
909
|
+
interface Class {
|
|
910
|
+
/**
|
|
911
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
912
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
913
|
+
* types.
|
|
914
|
+
*/
|
|
915
|
+
id: string | null;
|
|
916
|
+
/**
|
|
917
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
918
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
919
|
+
* case-sensitive.
|
|
920
|
+
*/
|
|
921
|
+
fullName: string | null;
|
|
922
|
+
}
|
|
923
|
+
/**
|
|
924
|
+
* The credit card transaction data for this sales receipt line's payment when
|
|
925
|
+
* using QuickBooks Merchant Services (QBMS).
|
|
926
|
+
*/
|
|
927
|
+
interface CreditCardTransaction {
|
|
928
|
+
/**
|
|
929
|
+
* The transaction request data originally supplied for this credit card
|
|
930
|
+
* transaction when using QuickBooks Merchant Services (QBMS).
|
|
931
|
+
*/
|
|
932
|
+
request: CreditCardTransaction.Request | null;
|
|
933
|
+
/**
|
|
934
|
+
* The transaction response data for this credit card transaction when using
|
|
935
|
+
* QuickBooks Merchant Services (QBMS).
|
|
936
|
+
*/
|
|
937
|
+
response: CreditCardTransaction.Response | null;
|
|
938
|
+
}
|
|
939
|
+
namespace CreditCardTransaction {
|
|
940
|
+
/**
|
|
941
|
+
* The transaction request data originally supplied for this credit card
|
|
942
|
+
* transaction when using QuickBooks Merchant Services (QBMS).
|
|
943
|
+
*/
|
|
944
|
+
interface Request {
|
|
945
|
+
/**
|
|
946
|
+
* The card's billing address.
|
|
947
|
+
*/
|
|
948
|
+
address: string | null;
|
|
949
|
+
/**
|
|
950
|
+
* The commercial card code identifies the type of business credit card being used
|
|
951
|
+
* (purchase, corporate, or business) for Visa and Mastercard transactions only.
|
|
952
|
+
* When provided, this code may qualify the transaction for lower processing fees
|
|
953
|
+
* compared to the standard rates that apply when no code is specified.
|
|
954
|
+
*/
|
|
955
|
+
commercialCardCode: string | null;
|
|
956
|
+
/**
|
|
957
|
+
* The month when the credit card expires.
|
|
958
|
+
*/
|
|
959
|
+
expirationMonth: number;
|
|
960
|
+
/**
|
|
961
|
+
* The year when the credit card expires.
|
|
962
|
+
*/
|
|
963
|
+
expirationYear: number;
|
|
964
|
+
/**
|
|
965
|
+
* The cardholder's name on the card.
|
|
966
|
+
*/
|
|
967
|
+
name: string | null;
|
|
968
|
+
/**
|
|
969
|
+
* The credit card number. Must be masked with lower case "x" and no dashes.
|
|
970
|
+
*/
|
|
971
|
+
number: string;
|
|
972
|
+
/**
|
|
973
|
+
* The card's billing address ZIP or postal code.
|
|
974
|
+
*/
|
|
975
|
+
postalCode: string | null;
|
|
976
|
+
/**
|
|
977
|
+
* Indicates whether this credit card transaction came from a card swipe
|
|
978
|
+
* (`card_present`) or not (`card_not_present`).
|
|
979
|
+
*/
|
|
980
|
+
transactionMode: 'card_not_present' | 'card_present' | null;
|
|
981
|
+
/**
|
|
982
|
+
* The QBMS transaction type from which the current transaction data originated.
|
|
983
|
+
*/
|
|
984
|
+
transactionType: 'authorization' | 'capture' | 'charge' | 'refund' | 'voice_authorization' | null;
|
|
985
|
+
}
|
|
986
|
+
/**
|
|
987
|
+
* The transaction response data for this credit card transaction when using
|
|
988
|
+
* QuickBooks Merchant Services (QBMS).
|
|
989
|
+
*/
|
|
990
|
+
interface Response {
|
|
991
|
+
/**
|
|
992
|
+
* The authorization code returned from the credit card processor to indicate that
|
|
993
|
+
* this charge will be paid by the card issuer.
|
|
994
|
+
*/
|
|
995
|
+
authorizationCode: string | null;
|
|
996
|
+
/**
|
|
997
|
+
* Indicates whether the street address supplied in the transaction request matches
|
|
998
|
+
* the customer's address on file at the card issuer.
|
|
999
|
+
*/
|
|
1000
|
+
avsStreetStatus: 'fail' | 'not_available' | 'pass' | null;
|
|
1001
|
+
/**
|
|
1002
|
+
* Indicates whether the customer postal ZIP code supplied in the transaction
|
|
1003
|
+
* request matches the customer's postal code recognized at the card issuer.
|
|
1004
|
+
*/
|
|
1005
|
+
avsZipStatus: 'fail' | 'not_available' | 'pass' | null;
|
|
1006
|
+
/**
|
|
1007
|
+
* Indicates whether the card security code supplied in the transaction request
|
|
1008
|
+
* matches the card security code recognized for that credit card number at the
|
|
1009
|
+
* card issuer.
|
|
1010
|
+
*/
|
|
1011
|
+
cardSecurityCodeMatch: 'fail' | 'not_available' | 'pass' | null;
|
|
1012
|
+
/**
|
|
1013
|
+
* A value returned from QBMS transactions for future use by the QuickBooks
|
|
1014
|
+
* Reconciliation feature.
|
|
1015
|
+
*/
|
|
1016
|
+
clientTransactionId: string | null;
|
|
1017
|
+
/**
|
|
1018
|
+
* The ID returned from the credit card processor for this credit card transaction.
|
|
1019
|
+
*/
|
|
1020
|
+
creditCardTransactionId: string;
|
|
1021
|
+
/**
|
|
1022
|
+
* The QBMS account number of the merchant who is running this transaction using
|
|
1023
|
+
* the customer's credit card.
|
|
1024
|
+
*/
|
|
1025
|
+
merchantAccountNumber: string;
|
|
1026
|
+
/**
|
|
1027
|
+
* An internal code returned by QuickBooks Merchant Services (QBMS) from the
|
|
1028
|
+
* transaction request, needed for the QuickBooks reconciliation feature.
|
|
1029
|
+
*/
|
|
1030
|
+
paymentGroupingCode: number | null;
|
|
1031
|
+
/**
|
|
1032
|
+
* Indicates whether this credit card transaction is known to have been
|
|
1033
|
+
* successfully processed by the card issuer.
|
|
1034
|
+
*/
|
|
1035
|
+
paymentStatus: 'completed' | 'unknown';
|
|
1036
|
+
/**
|
|
1037
|
+
* An internal ID returned by QuickBooks Merchant Services (QBMS) from the
|
|
1038
|
+
* transaction request, needed for the QuickBooks reconciliation feature.
|
|
1039
|
+
*/
|
|
1040
|
+
reconBatchId: string | null;
|
|
1041
|
+
/**
|
|
1042
|
+
* The status code returned in the original QBMS transaction response for this
|
|
1043
|
+
* credit card transaction.
|
|
1044
|
+
*/
|
|
1045
|
+
statusCode: number;
|
|
1046
|
+
/**
|
|
1047
|
+
* The status message returned in the original QBMS transaction response for this
|
|
1048
|
+
* credit card transaction.
|
|
1049
|
+
*/
|
|
1050
|
+
statusMessage: string;
|
|
1051
|
+
/**
|
|
1052
|
+
* An internal value for this credit card transaction, needed for the QuickBooks
|
|
1053
|
+
* reconciliation feature.
|
|
1054
|
+
*/
|
|
1055
|
+
transactionAuthorizationStamp: number | null;
|
|
1056
|
+
/**
|
|
1057
|
+
* The date and time when the credit card processor authorized this credit card
|
|
1058
|
+
* transaction.
|
|
1059
|
+
*/
|
|
1060
|
+
transactionAuthorizedAt: string;
|
|
1061
|
+
}
|
|
1062
|
+
}
|
|
1063
|
+
interface CustomField {
|
|
1064
|
+
/**
|
|
1065
|
+
* The name of the custom field, unique for the specified `ownerId`. For public
|
|
1066
|
+
* custom fields, this name is visible as a label in the QuickBooks UI.
|
|
1067
|
+
*/
|
|
1068
|
+
name: string;
|
|
1069
|
+
/**
|
|
1070
|
+
* The identifier of the owner of the custom field, which QuickBooks internally
|
|
1071
|
+
* calls a "data extension". For public custom fields visible in the UI, such as
|
|
1072
|
+
* those added by the QuickBooks user, this is always "0". For private custom
|
|
1073
|
+
* fields that are only visible to the application that created them, this is a
|
|
1074
|
+
* valid GUID identifying the owning application. Internally, Conductor always
|
|
1075
|
+
* fetches all public custom fields (those with an `ownerId` of "0") for all
|
|
1076
|
+
* objects.
|
|
1077
|
+
*/
|
|
1078
|
+
ownerId: string;
|
|
1079
|
+
/**
|
|
1080
|
+
* The data type of this custom field.
|
|
1081
|
+
*/
|
|
1082
|
+
type: 'amount_type' | 'date_time_type' | 'integer_type' | 'percent_type' | 'price_type' | 'quantity_type' | 'string_1024_type' | 'string_255_type';
|
|
1083
|
+
/**
|
|
1084
|
+
* The value of this custom field. The maximum length depends on the field's data
|
|
1085
|
+
* type.
|
|
1086
|
+
*/
|
|
1087
|
+
value: string;
|
|
1088
|
+
}
|
|
1089
|
+
/**
|
|
1090
|
+
* The site location where inventory for the item associated with this sales
|
|
1091
|
+
* receipt line is stored.
|
|
1092
|
+
*/
|
|
1093
|
+
interface InventorySite {
|
|
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 specific location (e.g., bin or shelf) within the inventory site where the
|
|
1109
|
+
* item associated with this sales receipt line is stored.
|
|
1110
|
+
*/
|
|
1111
|
+
interface InventorySiteLocation {
|
|
1112
|
+
/**
|
|
1113
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
1114
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
1115
|
+
* types.
|
|
1116
|
+
*/
|
|
1117
|
+
id: string | null;
|
|
1118
|
+
/**
|
|
1119
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
1120
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
1121
|
+
* case-sensitive.
|
|
1122
|
+
*/
|
|
1123
|
+
fullName: string | null;
|
|
1124
|
+
}
|
|
1125
|
+
/**
|
|
1126
|
+
* The item associated with this sales receipt line. This can refer to any good or
|
|
1127
|
+
* service that the business buys or sells, including item types such as a service
|
|
1128
|
+
* item, inventory item, or special calculation item like a discount item or
|
|
1129
|
+
* sales-tax item.
|
|
1130
|
+
*/
|
|
1131
|
+
interface Item {
|
|
1132
|
+
/**
|
|
1133
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
1134
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
1135
|
+
* types.
|
|
1136
|
+
*/
|
|
1137
|
+
id: string | null;
|
|
1138
|
+
/**
|
|
1139
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
1140
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
1141
|
+
* case-sensitive.
|
|
1142
|
+
*/
|
|
1143
|
+
fullName: string | null;
|
|
1144
|
+
}
|
|
1145
|
+
/**
|
|
1146
|
+
* Specifies an alternative unit-of-measure set when updating this sales receipt
|
|
1147
|
+
* line's `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to
|
|
1148
|
+
* select units from a different set than the item's default unit-of-measure set,
|
|
1149
|
+
* which remains unchanged on the item itself. The override applies only to this
|
|
1150
|
+
* specific line. For example, you can sell an item typically measured in volume
|
|
1151
|
+
* units using weight units in a specific transaction by specifying a different
|
|
1152
|
+
* unit-of-measure set with this field.
|
|
1153
|
+
*/
|
|
1154
|
+
interface OverrideUnitOfMeasureSet {
|
|
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 sales-tax code for this sales receipt line, determining whether it is
|
|
1170
|
+
* taxable or non-taxable. If set, this overrides any sales-tax codes defined on
|
|
1171
|
+
* the parent transaction or the associated item.
|
|
1172
|
+
*
|
|
1173
|
+
* Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
|
|
1174
|
+
* can also be created in QuickBooks. If QuickBooks is not set up to charge sales
|
|
1175
|
+
* tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
|
|
1176
|
+
* non-taxable code to all sales.
|
|
1177
|
+
*/
|
|
1178
|
+
interface SalesTaxCode {
|
|
1179
|
+
/**
|
|
1180
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
1181
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
1182
|
+
* types.
|
|
1183
|
+
*/
|
|
1184
|
+
id: string | null;
|
|
1185
|
+
/**
|
|
1186
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
1187
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
1188
|
+
* case-sensitive.
|
|
1189
|
+
*/
|
|
1190
|
+
fullName: string | null;
|
|
1191
|
+
}
|
|
1192
|
+
}
|
|
1193
|
+
/**
|
|
1194
|
+
* Specifies an alternative unit-of-measure set when updating this sales receipt
|
|
1195
|
+
* line group's `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows
|
|
1196
|
+
* you to select units from a different set than the item's default unit-of-measure
|
|
1197
|
+
* set, which remains unchanged on the item itself. The override applies only to
|
|
1198
|
+
* this specific line. For example, you can sell an item typically measured in
|
|
1199
|
+
* volume units using weight units in a specific transaction by specifying a
|
|
1200
|
+
* different unit-of-measure set with this field.
|
|
1201
|
+
*/
|
|
1202
|
+
interface OverrideUnitOfMeasureSet {
|
|
1203
|
+
/**
|
|
1204
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
1205
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
1206
|
+
* types.
|
|
1207
|
+
*/
|
|
1208
|
+
id: string | null;
|
|
1209
|
+
/**
|
|
1210
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
1211
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
1212
|
+
* case-sensitive.
|
|
1213
|
+
*/
|
|
1214
|
+
fullName: string | null;
|
|
1215
|
+
}
|
|
1216
|
+
}
|
|
1217
|
+
interface Line {
|
|
1218
|
+
/**
|
|
1219
|
+
* The unique identifier assigned by QuickBooks to this sales receipt line. This ID
|
|
1220
|
+
* is unique across all transaction line types.
|
|
1221
|
+
*/
|
|
1222
|
+
id: string;
|
|
1223
|
+
/**
|
|
1224
|
+
* The monetary amount of this sales receipt line, represented as a decimal string.
|
|
1225
|
+
* If both `quantity` and `rate` are specified but not `amount`, QuickBooks will
|
|
1226
|
+
* use them to calculate `amount`. If `amount`, `rate`, and `quantity` are all
|
|
1227
|
+
* unspecified, then QuickBooks will calculate `amount` based on a `quantity` of
|
|
1228
|
+
* `1` and the suggested `rate`. This field cannot be cleared.
|
|
1229
|
+
*/
|
|
1230
|
+
amount: string | null;
|
|
1231
|
+
/**
|
|
1232
|
+
* The sales receipt line's class. Classes can be used to categorize objects into
|
|
1233
|
+
* meaningful segments, such as department, location, or type of work. In
|
|
1234
|
+
* QuickBooks, class tracking is off by default. If a class is specified for the
|
|
1235
|
+
* entire parent transaction, it is automatically applied to all sales receipt
|
|
1236
|
+
* lines unless overridden here, at the transaction line level.
|
|
1237
|
+
*/
|
|
1238
|
+
class: Line.Class | null;
|
|
1239
|
+
/**
|
|
1240
|
+
* The credit card transaction data for this sales receipt line's payment when
|
|
1241
|
+
* using QuickBooks Merchant Services (QBMS).
|
|
1242
|
+
*/
|
|
1243
|
+
creditCardTransaction: Line.CreditCardTransaction | null;
|
|
1244
|
+
/**
|
|
1245
|
+
* The custom fields for the sales receipt line object, added as user-defined data
|
|
1246
|
+
* extensions, not included in the standard QuickBooks object.
|
|
1247
|
+
*/
|
|
1248
|
+
customFields: Array<Line.CustomField>;
|
|
1249
|
+
/**
|
|
1250
|
+
* A description of this sales receipt line.
|
|
1251
|
+
*/
|
|
1252
|
+
description: string | null;
|
|
1253
|
+
/**
|
|
1254
|
+
* The expiration date for the serial number or lot number of the item associated
|
|
1255
|
+
* with this sales receipt line, in ISO 8601 format (YYYY-MM-DD). This is
|
|
1256
|
+
* particularly relevant for perishable or time-sensitive inventory items. Note
|
|
1257
|
+
* that this field is only supported on QuickBooks Desktop 2023 or later.
|
|
1258
|
+
*/
|
|
1259
|
+
expirationDate: string | null;
|
|
1260
|
+
/**
|
|
1261
|
+
* The site location where inventory for the item associated with this sales
|
|
1262
|
+
* receipt line is stored.
|
|
1263
|
+
*/
|
|
1264
|
+
inventorySite: Line.InventorySite | null;
|
|
1265
|
+
/**
|
|
1266
|
+
* The specific location (e.g., bin or shelf) within the inventory site where the
|
|
1267
|
+
* item associated with this sales receipt line is stored.
|
|
1268
|
+
*/
|
|
1269
|
+
inventorySiteLocation: Line.InventorySiteLocation | null;
|
|
1270
|
+
/**
|
|
1271
|
+
* The item associated with this sales receipt line. This can refer to any good or
|
|
1272
|
+
* service that the business buys or sells, including item types such as a service
|
|
1273
|
+
* item, inventory item, or special calculation item like a discount item or
|
|
1274
|
+
* sales-tax item.
|
|
1275
|
+
*/
|
|
1276
|
+
item: Line.Item | null;
|
|
1277
|
+
/**
|
|
1278
|
+
* The lot number of the item associated with this sales receipt line. Used for
|
|
1279
|
+
* tracking groups of inventory items that are purchased or manufactured together.
|
|
1280
|
+
*/
|
|
1281
|
+
lotNumber: string | null;
|
|
1282
|
+
/**
|
|
1283
|
+
* The type of object. This value is always `"qbd_sales_receipt_line"`.
|
|
1284
|
+
*/
|
|
1285
|
+
objectType: 'qbd_sales_receipt_line';
|
|
1286
|
+
/**
|
|
1287
|
+
* A built-in custom field for additional information specific to this sales
|
|
1288
|
+
* receipt line. Unlike the user-defined fields in the `customFields` array, this
|
|
1289
|
+
* is a standard QuickBooks field that exists for all sales receipt lines for
|
|
1290
|
+
* convenience. Developers often use this field for tracking information that
|
|
1291
|
+
* doesn't fit into other standard QuickBooks fields. Hidden by default in the
|
|
1292
|
+
* QuickBooks UI.
|
|
1293
|
+
*/
|
|
1294
|
+
otherCustomField1: string | null;
|
|
1295
|
+
/**
|
|
1296
|
+
* A second built-in custom field for additional information specific to this sales
|
|
1297
|
+
* receipt line. Unlike the user-defined fields in the `customFields` array, this
|
|
1298
|
+
* is a standard QuickBooks field that exists for all sales receipt lines for
|
|
1299
|
+
* convenience. Like `otherCustomField1`, developers often use this field for
|
|
1300
|
+
* tracking information that doesn't fit into other standard QuickBooks fields.
|
|
1301
|
+
* Hidden by default in the QuickBooks UI.
|
|
1302
|
+
*/
|
|
1303
|
+
otherCustomField2: string | null;
|
|
1304
|
+
/**
|
|
1305
|
+
* Specifies an alternative unit-of-measure set when updating this sales receipt
|
|
1306
|
+
* line's `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to
|
|
1307
|
+
* select units from a different set than the item's default unit-of-measure set,
|
|
1308
|
+
* which remains unchanged on the item itself. The override applies only to this
|
|
1309
|
+
* specific line. For example, you can sell an item typically measured in volume
|
|
1310
|
+
* units using weight units in a specific transaction by specifying a different
|
|
1311
|
+
* unit-of-measure set with this field.
|
|
1312
|
+
*/
|
|
1313
|
+
overrideUnitOfMeasureSet: Line.OverrideUnitOfMeasureSet | null;
|
|
1314
|
+
/**
|
|
1315
|
+
* The quantity of the item associated with this sales receipt line. This field
|
|
1316
|
+
* cannot be cleared.
|
|
1317
|
+
*
|
|
1318
|
+
* **NOTE**: Do not use this field if the associated item is a discount item.
|
|
1319
|
+
*/
|
|
1320
|
+
quantity: number | null;
|
|
1321
|
+
/**
|
|
1322
|
+
* The price per unit for this sales receipt line. If both `rate` and `amount` are
|
|
1323
|
+
* specified, `rate` will be ignored. If both `quantity` and `amount` are specified
|
|
1324
|
+
* but not `rate`, QuickBooks will use them to calculate `rate`. Represented as a
|
|
1325
|
+
* decimal string. This field cannot be cleared.
|
|
1326
|
+
*/
|
|
1327
|
+
rate: string | null;
|
|
1328
|
+
/**
|
|
1329
|
+
* The price of this sales receipt line expressed as a percentage. Typically used
|
|
1330
|
+
* for discount or markup items.
|
|
1331
|
+
*/
|
|
1332
|
+
ratePercent: string | null;
|
|
1333
|
+
/**
|
|
1334
|
+
* The sales-tax code for this sales receipt line, determining whether it is
|
|
1335
|
+
* taxable or non-taxable. If set, this overrides any sales-tax codes defined on
|
|
1336
|
+
* the parent transaction or the associated item.
|
|
1337
|
+
*
|
|
1338
|
+
* Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
|
|
1339
|
+
* can also be created in QuickBooks. If QuickBooks is not set up to charge sales
|
|
1340
|
+
* tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
|
|
1341
|
+
* non-taxable code to all sales.
|
|
1342
|
+
*/
|
|
1343
|
+
salesTaxCode: Line.SalesTaxCode | null;
|
|
1344
|
+
/**
|
|
1345
|
+
* The serial number of the item associated with this sales receipt line. This is
|
|
1346
|
+
* used for tracking individual units of serialized inventory items.
|
|
1347
|
+
*/
|
|
1348
|
+
serialNumber: string | null;
|
|
1349
|
+
/**
|
|
1350
|
+
* The date on which the service for this sales receipt line was or will be
|
|
1351
|
+
* performed, in ISO 8601 format (YYYY-MM-DD). This is particularly relevant for
|
|
1352
|
+
* service items.
|
|
1353
|
+
*/
|
|
1354
|
+
serviceDate: string | null;
|
|
1355
|
+
/**
|
|
1356
|
+
* The unit-of-measure used for the `quantity` in this sales receipt line. Must be
|
|
1357
|
+
* a valid unit within the item's available units of measure.
|
|
1358
|
+
*/
|
|
1359
|
+
unitOfMeasure: string | null;
|
|
1360
|
+
}
|
|
1361
|
+
namespace Line {
|
|
1362
|
+
/**
|
|
1363
|
+
* The sales receipt line's class. Classes can be used to categorize objects into
|
|
1364
|
+
* meaningful segments, such as department, location, or type of work. In
|
|
1365
|
+
* QuickBooks, class tracking is off by default. If a class is specified for the
|
|
1366
|
+
* entire parent transaction, it is automatically applied to all sales receipt
|
|
1367
|
+
* lines unless overridden here, at the transaction line level.
|
|
1368
|
+
*/
|
|
1369
|
+
interface Class {
|
|
1370
|
+
/**
|
|
1371
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
1372
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
1373
|
+
* types.
|
|
1374
|
+
*/
|
|
1375
|
+
id: string | null;
|
|
1376
|
+
/**
|
|
1377
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
1378
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
1379
|
+
* case-sensitive.
|
|
1380
|
+
*/
|
|
1381
|
+
fullName: string | null;
|
|
1382
|
+
}
|
|
1383
|
+
/**
|
|
1384
|
+
* The credit card transaction data for this sales receipt line's payment when
|
|
1385
|
+
* using QuickBooks Merchant Services (QBMS).
|
|
1386
|
+
*/
|
|
1387
|
+
interface CreditCardTransaction {
|
|
1388
|
+
/**
|
|
1389
|
+
* The transaction request data originally supplied for this credit card
|
|
1390
|
+
* transaction when using QuickBooks Merchant Services (QBMS).
|
|
1391
|
+
*/
|
|
1392
|
+
request: CreditCardTransaction.Request | null;
|
|
1393
|
+
/**
|
|
1394
|
+
* The transaction response data for this credit card transaction when using
|
|
1395
|
+
* QuickBooks Merchant Services (QBMS).
|
|
1396
|
+
*/
|
|
1397
|
+
response: CreditCardTransaction.Response | null;
|
|
1398
|
+
}
|
|
1399
|
+
namespace CreditCardTransaction {
|
|
1400
|
+
/**
|
|
1401
|
+
* The transaction request data originally supplied for this credit card
|
|
1402
|
+
* transaction when using QuickBooks Merchant Services (QBMS).
|
|
1403
|
+
*/
|
|
1404
|
+
interface Request {
|
|
1405
|
+
/**
|
|
1406
|
+
* The card's billing address.
|
|
1407
|
+
*/
|
|
1408
|
+
address: string | null;
|
|
1409
|
+
/**
|
|
1410
|
+
* The commercial card code identifies the type of business credit card being used
|
|
1411
|
+
* (purchase, corporate, or business) for Visa and Mastercard transactions only.
|
|
1412
|
+
* When provided, this code may qualify the transaction for lower processing fees
|
|
1413
|
+
* compared to the standard rates that apply when no code is specified.
|
|
1414
|
+
*/
|
|
1415
|
+
commercialCardCode: string | null;
|
|
1416
|
+
/**
|
|
1417
|
+
* The month when the credit card expires.
|
|
1418
|
+
*/
|
|
1419
|
+
expirationMonth: number;
|
|
1420
|
+
/**
|
|
1421
|
+
* The year when the credit card expires.
|
|
1422
|
+
*/
|
|
1423
|
+
expirationYear: number;
|
|
1424
|
+
/**
|
|
1425
|
+
* The cardholder's name on the card.
|
|
1426
|
+
*/
|
|
1427
|
+
name: string | null;
|
|
1428
|
+
/**
|
|
1429
|
+
* The credit card number. Must be masked with lower case "x" and no dashes.
|
|
1430
|
+
*/
|
|
1431
|
+
number: string;
|
|
1432
|
+
/**
|
|
1433
|
+
* The card's billing address ZIP or postal code.
|
|
1434
|
+
*/
|
|
1435
|
+
postalCode: string | null;
|
|
1436
|
+
/**
|
|
1437
|
+
* Indicates whether this credit card transaction came from a card swipe
|
|
1438
|
+
* (`card_present`) or not (`card_not_present`).
|
|
1439
|
+
*/
|
|
1440
|
+
transactionMode: 'card_not_present' | 'card_present' | null;
|
|
1441
|
+
/**
|
|
1442
|
+
* The QBMS transaction type from which the current transaction data originated.
|
|
1443
|
+
*/
|
|
1444
|
+
transactionType: 'authorization' | 'capture' | 'charge' | 'refund' | 'voice_authorization' | null;
|
|
1445
|
+
}
|
|
1446
|
+
/**
|
|
1447
|
+
* The transaction response data for this credit card transaction when using
|
|
1448
|
+
* QuickBooks Merchant Services (QBMS).
|
|
1449
|
+
*/
|
|
1450
|
+
interface Response {
|
|
1451
|
+
/**
|
|
1452
|
+
* The authorization code returned from the credit card processor to indicate that
|
|
1453
|
+
* this charge will be paid by the card issuer.
|
|
1454
|
+
*/
|
|
1455
|
+
authorizationCode: string | null;
|
|
1456
|
+
/**
|
|
1457
|
+
* Indicates whether the street address supplied in the transaction request matches
|
|
1458
|
+
* the customer's address on file at the card issuer.
|
|
1459
|
+
*/
|
|
1460
|
+
avsStreetStatus: 'fail' | 'not_available' | 'pass' | null;
|
|
1461
|
+
/**
|
|
1462
|
+
* Indicates whether the customer postal ZIP code supplied in the transaction
|
|
1463
|
+
* request matches the customer's postal code recognized at the card issuer.
|
|
1464
|
+
*/
|
|
1465
|
+
avsZipStatus: 'fail' | 'not_available' | 'pass' | null;
|
|
1466
|
+
/**
|
|
1467
|
+
* Indicates whether the card security code supplied in the transaction request
|
|
1468
|
+
* matches the card security code recognized for that credit card number at the
|
|
1469
|
+
* card issuer.
|
|
1470
|
+
*/
|
|
1471
|
+
cardSecurityCodeMatch: 'fail' | 'not_available' | 'pass' | null;
|
|
1472
|
+
/**
|
|
1473
|
+
* A value returned from QBMS transactions for future use by the QuickBooks
|
|
1474
|
+
* Reconciliation feature.
|
|
1475
|
+
*/
|
|
1476
|
+
clientTransactionId: string | null;
|
|
1477
|
+
/**
|
|
1478
|
+
* The ID returned from the credit card processor for this credit card transaction.
|
|
1479
|
+
*/
|
|
1480
|
+
creditCardTransactionId: string;
|
|
1481
|
+
/**
|
|
1482
|
+
* The QBMS account number of the merchant who is running this transaction using
|
|
1483
|
+
* the customer's credit card.
|
|
1484
|
+
*/
|
|
1485
|
+
merchantAccountNumber: string;
|
|
1486
|
+
/**
|
|
1487
|
+
* An internal code returned by QuickBooks Merchant Services (QBMS) from the
|
|
1488
|
+
* transaction request, needed for the QuickBooks reconciliation feature.
|
|
1489
|
+
*/
|
|
1490
|
+
paymentGroupingCode: number | null;
|
|
1491
|
+
/**
|
|
1492
|
+
* Indicates whether this credit card transaction is known to have been
|
|
1493
|
+
* successfully processed by the card issuer.
|
|
1494
|
+
*/
|
|
1495
|
+
paymentStatus: 'completed' | 'unknown';
|
|
1496
|
+
/**
|
|
1497
|
+
* An internal ID returned by QuickBooks Merchant Services (QBMS) from the
|
|
1498
|
+
* transaction request, needed for the QuickBooks reconciliation feature.
|
|
1499
|
+
*/
|
|
1500
|
+
reconBatchId: string | null;
|
|
1501
|
+
/**
|
|
1502
|
+
* The status code returned in the original QBMS transaction response for this
|
|
1503
|
+
* credit card transaction.
|
|
1504
|
+
*/
|
|
1505
|
+
statusCode: number;
|
|
1506
|
+
/**
|
|
1507
|
+
* The status message returned in the original QBMS transaction response for this
|
|
1508
|
+
* credit card transaction.
|
|
1509
|
+
*/
|
|
1510
|
+
statusMessage: string;
|
|
1511
|
+
/**
|
|
1512
|
+
* An internal value for this credit card transaction, needed for the QuickBooks
|
|
1513
|
+
* reconciliation feature.
|
|
1514
|
+
*/
|
|
1515
|
+
transactionAuthorizationStamp: number | null;
|
|
1516
|
+
/**
|
|
1517
|
+
* The date and time when the credit card processor authorized this credit card
|
|
1518
|
+
* transaction.
|
|
1519
|
+
*/
|
|
1520
|
+
transactionAuthorizedAt: string;
|
|
1521
|
+
}
|
|
1522
|
+
}
|
|
1523
|
+
interface CustomField {
|
|
1524
|
+
/**
|
|
1525
|
+
* The name of the custom field, unique for the specified `ownerId`. For public
|
|
1526
|
+
* custom fields, this name is visible as a label in the QuickBooks UI.
|
|
1527
|
+
*/
|
|
1528
|
+
name: string;
|
|
1529
|
+
/**
|
|
1530
|
+
* The identifier of the owner of the custom field, which QuickBooks internally
|
|
1531
|
+
* calls a "data extension". For public custom fields visible in the UI, such as
|
|
1532
|
+
* those added by the QuickBooks user, this is always "0". For private custom
|
|
1533
|
+
* fields that are only visible to the application that created them, this is a
|
|
1534
|
+
* valid GUID identifying the owning application. Internally, Conductor always
|
|
1535
|
+
* fetches all public custom fields (those with an `ownerId` of "0") for all
|
|
1536
|
+
* objects.
|
|
1537
|
+
*/
|
|
1538
|
+
ownerId: string;
|
|
1539
|
+
/**
|
|
1540
|
+
* The data type of this custom field.
|
|
1541
|
+
*/
|
|
1542
|
+
type: 'amount_type' | 'date_time_type' | 'integer_type' | 'percent_type' | 'price_type' | 'quantity_type' | 'string_1024_type' | 'string_255_type';
|
|
1543
|
+
/**
|
|
1544
|
+
* The value of this custom field. The maximum length depends on the field's data
|
|
1545
|
+
* type.
|
|
1546
|
+
*/
|
|
1547
|
+
value: string;
|
|
1548
|
+
}
|
|
1549
|
+
/**
|
|
1550
|
+
* The site location where inventory for the item associated with this sales
|
|
1551
|
+
* receipt line is stored.
|
|
1552
|
+
*/
|
|
1553
|
+
interface InventorySite {
|
|
1554
|
+
/**
|
|
1555
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
1556
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
1557
|
+
* types.
|
|
1558
|
+
*/
|
|
1559
|
+
id: string | null;
|
|
1560
|
+
/**
|
|
1561
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
1562
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
1563
|
+
* case-sensitive.
|
|
1564
|
+
*/
|
|
1565
|
+
fullName: string | null;
|
|
1566
|
+
}
|
|
1567
|
+
/**
|
|
1568
|
+
* The specific location (e.g., bin or shelf) within the inventory site where the
|
|
1569
|
+
* item associated with this sales receipt line is stored.
|
|
1570
|
+
*/
|
|
1571
|
+
interface InventorySiteLocation {
|
|
1572
|
+
/**
|
|
1573
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
1574
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
1575
|
+
* types.
|
|
1576
|
+
*/
|
|
1577
|
+
id: string | null;
|
|
1578
|
+
/**
|
|
1579
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
1580
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
1581
|
+
* case-sensitive.
|
|
1582
|
+
*/
|
|
1583
|
+
fullName: string | null;
|
|
1584
|
+
}
|
|
1585
|
+
/**
|
|
1586
|
+
* The item associated with this sales receipt line. This can refer to any good or
|
|
1587
|
+
* service that the business buys or sells, including item types such as a service
|
|
1588
|
+
* item, inventory item, or special calculation item like a discount item or
|
|
1589
|
+
* sales-tax item.
|
|
1590
|
+
*/
|
|
1591
|
+
interface Item {
|
|
1592
|
+
/**
|
|
1593
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
1594
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
1595
|
+
* types.
|
|
1596
|
+
*/
|
|
1597
|
+
id: string | null;
|
|
1598
|
+
/**
|
|
1599
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
1600
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
1601
|
+
* case-sensitive.
|
|
1602
|
+
*/
|
|
1603
|
+
fullName: string | null;
|
|
1604
|
+
}
|
|
1605
|
+
/**
|
|
1606
|
+
* Specifies an alternative unit-of-measure set when updating this sales receipt
|
|
1607
|
+
* line's `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to
|
|
1608
|
+
* select units from a different set than the item's default unit-of-measure set,
|
|
1609
|
+
* which remains unchanged on the item itself. The override applies only to this
|
|
1610
|
+
* specific line. For example, you can sell an item typically measured in volume
|
|
1611
|
+
* units using weight units in a specific transaction by specifying a different
|
|
1612
|
+
* unit-of-measure set with this field.
|
|
1613
|
+
*/
|
|
1614
|
+
interface OverrideUnitOfMeasureSet {
|
|
1615
|
+
/**
|
|
1616
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
1617
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
1618
|
+
* types.
|
|
1619
|
+
*/
|
|
1620
|
+
id: string | null;
|
|
1621
|
+
/**
|
|
1622
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
1623
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
1624
|
+
* case-sensitive.
|
|
1625
|
+
*/
|
|
1626
|
+
fullName: string | null;
|
|
1627
|
+
}
|
|
1628
|
+
/**
|
|
1629
|
+
* The sales-tax code for this sales receipt line, determining whether it is
|
|
1630
|
+
* taxable or non-taxable. If set, this overrides any sales-tax codes defined on
|
|
1631
|
+
* the parent transaction or the associated item.
|
|
1632
|
+
*
|
|
1633
|
+
* Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
|
|
1634
|
+
* can also be created in QuickBooks. If QuickBooks is not set up to charge sales
|
|
1635
|
+
* tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
|
|
1636
|
+
* non-taxable code to all sales.
|
|
1637
|
+
*/
|
|
1638
|
+
interface SalesTaxCode {
|
|
1639
|
+
/**
|
|
1640
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
1641
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
1642
|
+
* types.
|
|
1643
|
+
*/
|
|
1644
|
+
id: string | null;
|
|
1645
|
+
/**
|
|
1646
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
1647
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
1648
|
+
* case-sensitive.
|
|
1649
|
+
*/
|
|
1650
|
+
fullName: string | null;
|
|
1651
|
+
}
|
|
1652
|
+
}
|
|
1653
|
+
/**
|
|
1654
|
+
* The sales receipt's payment method (e.g., cash, check, credit card).
|
|
1655
|
+
*/
|
|
1656
|
+
interface PaymentMethod {
|
|
1657
|
+
/**
|
|
1658
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
1659
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
1660
|
+
* types.
|
|
1661
|
+
*/
|
|
1662
|
+
id: string | null;
|
|
1663
|
+
/**
|
|
1664
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
1665
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
1666
|
+
* case-sensitive.
|
|
1667
|
+
*/
|
|
1668
|
+
fullName: string | null;
|
|
1669
|
+
}
|
|
1670
|
+
/**
|
|
1671
|
+
* The sales receipt's sales representative. Sales representatives can be
|
|
1672
|
+
* employees, vendors, or other names in QuickBooks.
|
|
1673
|
+
*/
|
|
1674
|
+
interface SalesRepresentative {
|
|
1675
|
+
/**
|
|
1676
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
1677
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
1678
|
+
* types.
|
|
1679
|
+
*/
|
|
1680
|
+
id: string | null;
|
|
1681
|
+
/**
|
|
1682
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
1683
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
1684
|
+
* case-sensitive.
|
|
1685
|
+
*/
|
|
1686
|
+
fullName: string | null;
|
|
1687
|
+
}
|
|
1688
|
+
/**
|
|
1689
|
+
* The sales-tax code for this sales receipt, determining whether it is taxable or
|
|
1690
|
+
* non-taxable. This can be overridden at the transaction-line level.
|
|
1691
|
+
*
|
|
1692
|
+
* Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
|
|
1693
|
+
* can also be created in QuickBooks. If QuickBooks is not set up to charge sales
|
|
1694
|
+
* tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
|
|
1695
|
+
* non-taxable code to all sales.
|
|
1696
|
+
*/
|
|
1697
|
+
interface SalesTaxCode {
|
|
1698
|
+
/**
|
|
1699
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
1700
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
1701
|
+
* types.
|
|
1702
|
+
*/
|
|
1703
|
+
id: string | null;
|
|
1704
|
+
/**
|
|
1705
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
1706
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
1707
|
+
* case-sensitive.
|
|
1708
|
+
*/
|
|
1709
|
+
fullName: string | null;
|
|
1710
|
+
}
|
|
1711
|
+
/**
|
|
1712
|
+
* The sales-tax item used to calculate the actual tax amount for this sales
|
|
1713
|
+
* receipt's transactions by applying a specific tax rate collected for a single
|
|
1714
|
+
* tax agency. Unlike `salesTaxCode`, which only indicates general taxability, this
|
|
1715
|
+
* field drives the actual tax calculation and reporting.
|
|
1716
|
+
*
|
|
1717
|
+
* For sales receipts, while using this field to specify a single tax item/group
|
|
1718
|
+
* that applies uniformly is recommended, complex tax scenarios may require
|
|
1719
|
+
* alternative approaches. In such cases, you can set this field to a 0% tax item
|
|
1720
|
+
* (conventionally named "Tax Calculated On Invoice") and handle tax calculations
|
|
1721
|
+
* through line items instead. When using line items for taxes, note that only
|
|
1722
|
+
* individual tax items (not tax groups) can be used, subtotals can help apply a
|
|
1723
|
+
* tax to multiple items but only the first tax line after a subtotal is calculated
|
|
1724
|
+
* automatically (subsequent tax lines require manual amounts), and the rate column
|
|
1725
|
+
* will always display the actual tax amount rather than the rate percentage.
|
|
1726
|
+
*/
|
|
1727
|
+
interface SalesTaxItem {
|
|
1728
|
+
/**
|
|
1729
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
1730
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
1731
|
+
* types.
|
|
1732
|
+
*/
|
|
1733
|
+
id: string | null;
|
|
1734
|
+
/**
|
|
1735
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
1736
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
1737
|
+
* case-sensitive.
|
|
1738
|
+
*/
|
|
1739
|
+
fullName: string | null;
|
|
1740
|
+
}
|
|
1741
|
+
/**
|
|
1742
|
+
* The sales receipt's shipping address.
|
|
1743
|
+
*/
|
|
1744
|
+
interface ShippingAddress {
|
|
1745
|
+
/**
|
|
1746
|
+
* The city, district, suburb, town, or village name of the address.
|
|
1747
|
+
*/
|
|
1748
|
+
city: string | null;
|
|
1749
|
+
/**
|
|
1750
|
+
* The country name of the address.
|
|
1751
|
+
*/
|
|
1752
|
+
country: string | null;
|
|
1753
|
+
/**
|
|
1754
|
+
* The first line of the address (e.g., street, PO Box, or company name).
|
|
1755
|
+
*/
|
|
1756
|
+
line1: string | null;
|
|
1757
|
+
/**
|
|
1758
|
+
* The second line of the address, if needed (e.g., apartment, suite, unit, or
|
|
1759
|
+
* building).
|
|
1760
|
+
*/
|
|
1761
|
+
line2: string | null;
|
|
1762
|
+
/**
|
|
1763
|
+
* The third line of the address, if needed.
|
|
1764
|
+
*/
|
|
1765
|
+
line3: string | null;
|
|
1766
|
+
/**
|
|
1767
|
+
* The fourth line of the address, if needed.
|
|
1768
|
+
*/
|
|
1769
|
+
line4: string | null;
|
|
1770
|
+
/**
|
|
1771
|
+
* The fifth line of the address, if needed.
|
|
1772
|
+
*/
|
|
1773
|
+
line5: string | null;
|
|
1774
|
+
/**
|
|
1775
|
+
* A note written at the bottom of the address in the form in which it appears,
|
|
1776
|
+
* such as the invoice form.
|
|
1777
|
+
*/
|
|
1778
|
+
note: string | null;
|
|
1779
|
+
/**
|
|
1780
|
+
* The postal code or ZIP code of the address.
|
|
1781
|
+
*/
|
|
1782
|
+
postalCode: string | null;
|
|
1783
|
+
/**
|
|
1784
|
+
* The state, county, province, or region name of the address.
|
|
1785
|
+
*/
|
|
1786
|
+
state: string | null;
|
|
1787
|
+
}
|
|
1788
|
+
/**
|
|
1789
|
+
* The shipping method used for this sales receipt, such as standard mail or
|
|
1790
|
+
* overnight delivery.
|
|
1791
|
+
*/
|
|
1792
|
+
interface ShippingMethod {
|
|
1793
|
+
/**
|
|
1794
|
+
* The unique identifier assigned by QuickBooks to this object. This ID is unique
|
|
1795
|
+
* across all objects of the same type, but not across different QuickBooks object
|
|
1796
|
+
* types.
|
|
1797
|
+
*/
|
|
1798
|
+
id: string | null;
|
|
1799
|
+
/**
|
|
1800
|
+
* The fully-qualified unique name for this object, formed by combining the names
|
|
1801
|
+
* of its parent objects with its own `name`, separated by colons. Not
|
|
1802
|
+
* case-sensitive.
|
|
1803
|
+
*/
|
|
1804
|
+
fullName: string | null;
|
|
1805
|
+
}
|
|
1806
|
+
}
|
|
1807
|
+
export interface SalesReceiptDeleteResponse {
|
|
1808
|
+
/**
|
|
1809
|
+
* The QuickBooks-assigned unique identifier of the deleted sales receipt.
|
|
1810
|
+
*/
|
|
1811
|
+
id: string;
|
|
1812
|
+
/**
|
|
1813
|
+
* Indicates whether the sales receipt was deleted.
|
|
1814
|
+
*/
|
|
1815
|
+
deleted: boolean;
|
|
1816
|
+
/**
|
|
1817
|
+
* The type of object. This value is always `"qbd_sales_receipt"`.
|
|
1818
|
+
*/
|
|
1819
|
+
objectType: 'qbd_sales_receipt';
|
|
1820
|
+
/**
|
|
1821
|
+
* The case-sensitive user-defined reference number of the deleted sales receipt.
|
|
1822
|
+
*/
|
|
1823
|
+
refNumber: string | null;
|
|
1824
|
+
}
|
|
1825
|
+
export interface SalesReceiptCreateParams {
|
|
1826
|
+
/**
|
|
1827
|
+
* Body param: The date of this sales receipt, in ISO 8601 format (YYYY-MM-DD).
|
|
1828
|
+
*/
|
|
1829
|
+
transactionDate: string;
|
|
1830
|
+
/**
|
|
1831
|
+
* Header param: The ID of the End-User to receive this request.
|
|
1832
|
+
*/
|
|
1833
|
+
conductorEndUserId: string;
|
|
1834
|
+
/**
|
|
1835
|
+
* Body param: The sales receipt's billing address.
|
|
1836
|
+
*/
|
|
1837
|
+
billingAddress?: SalesReceiptCreateParams.BillingAddress;
|
|
1838
|
+
/**
|
|
1839
|
+
* Body param: The check number of a check received for this sales receipt.
|
|
1840
|
+
*/
|
|
1841
|
+
checkNumber?: string;
|
|
1842
|
+
/**
|
|
1843
|
+
* Body param: The sales receipt's class. Classes can be used to categorize objects
|
|
1844
|
+
* into meaningful segments, such as department, location, or type of work. In
|
|
1845
|
+
* QuickBooks, class tracking is off by default. A class defined here is
|
|
1846
|
+
* automatically used in this sales receipt's line items unless overridden at the
|
|
1847
|
+
* line item level.
|
|
1848
|
+
*/
|
|
1849
|
+
classId?: string;
|
|
1850
|
+
/**
|
|
1851
|
+
* Body param: The credit card transaction data for this sales receipt's payment
|
|
1852
|
+
* when using QuickBooks Merchant Services (QBMS). If specifying this field, you
|
|
1853
|
+
* must also specify the `paymentMethod` field.
|
|
1854
|
+
*/
|
|
1855
|
+
creditCardTransaction?: SalesReceiptCreateParams.CreditCardTransaction;
|
|
1856
|
+
/**
|
|
1857
|
+
* Body param: The customer or customer-job to which the payment for this sales
|
|
1858
|
+
* receipt is credited.
|
|
1859
|
+
*/
|
|
1860
|
+
customerId?: string;
|
|
1861
|
+
/**
|
|
1862
|
+
* Body param: The message to display to the customer on the sales receipt.
|
|
1863
|
+
*/
|
|
1864
|
+
customerMessageId?: string;
|
|
1865
|
+
/**
|
|
1866
|
+
* Body param: The account where the funds for this sales receipt will be or have
|
|
1867
|
+
* been deposited.
|
|
1868
|
+
*/
|
|
1869
|
+
depositToAccountId?: string;
|
|
1870
|
+
/**
|
|
1871
|
+
* Body param: The predefined template in QuickBooks that determines the layout and
|
|
1872
|
+
* formatting for this sales receipt when printed or displayed.
|
|
1873
|
+
*/
|
|
1874
|
+
documentTemplateId?: string;
|
|
1875
|
+
/**
|
|
1876
|
+
* Body param: The date by which this sales receipt must be paid, in ISO 8601
|
|
1877
|
+
* format (YYYY-MM-DD).
|
|
1878
|
+
*
|
|
1879
|
+
* **NOTE**: For sales receipts, this field is often `null` because sales receipts
|
|
1880
|
+
* are generally used for point-of-sale payments, where full payment is received at
|
|
1881
|
+
* the time of purchase.
|
|
1882
|
+
*/
|
|
1883
|
+
dueDate?: string;
|
|
1884
|
+
/**
|
|
1885
|
+
* Body param: The market exchange rate between this sales receipt's currency and
|
|
1886
|
+
* the home currency in QuickBooks at the time of this transaction. Represented as
|
|
1887
|
+
* a decimal value (e.g., 1.2345 for 1 EUR = 1.2345 USD if USD is the home
|
|
1888
|
+
* currency).
|
|
1889
|
+
*/
|
|
1890
|
+
exchangeRate?: number;
|
|
1891
|
+
/**
|
|
1892
|
+
* Body param: A globally unique identifier (GUID) you, the developer, can provide
|
|
1893
|
+
* for tracking this object in your external system. This field is immutable and
|
|
1894
|
+
* can only be set during object creation.
|
|
1895
|
+
*
|
|
1896
|
+
* **IMPORTANT**: This field must be formatted as a valid GUID; otherwise,
|
|
1897
|
+
* QuickBooks will return an error.
|
|
1898
|
+
*/
|
|
1899
|
+
externalId?: string;
|
|
1900
|
+
/**
|
|
1901
|
+
* Body param: Indicates whether this sales receipt has not been completed.
|
|
1902
|
+
*/
|
|
1903
|
+
isPending?: boolean;
|
|
1904
|
+
/**
|
|
1905
|
+
* Body param: Indicates whether this sales receipt is included in the queue of
|
|
1906
|
+
* documents for QuickBooks to email to the customer.
|
|
1907
|
+
*/
|
|
1908
|
+
isQueuedForEmail?: boolean;
|
|
1909
|
+
/**
|
|
1910
|
+
* Body param: Indicates whether this sales receipt is included in the queue of
|
|
1911
|
+
* documents for QuickBooks to print.
|
|
1912
|
+
*/
|
|
1913
|
+
isQueuedForPrint?: boolean;
|
|
1914
|
+
/**
|
|
1915
|
+
* Body param: The sales receipt's line item groups, each representing a predefined
|
|
1916
|
+
* set of related items.
|
|
1917
|
+
*
|
|
1918
|
+
* **IMPORTANT**: You must specify `lines`, `lineGroups`, or both when creating a
|
|
1919
|
+
* sales receipt.
|
|
1920
|
+
*/
|
|
1921
|
+
lineGroups?: Array<SalesReceiptCreateParams.LineGroup>;
|
|
1922
|
+
/**
|
|
1923
|
+
* Body param: The sales receipt's line items, each representing a single product
|
|
1924
|
+
* or service sold.
|
|
1925
|
+
*
|
|
1926
|
+
* **IMPORTANT**: You must specify `lines`, `lineGroups`, or both when creating a
|
|
1927
|
+
* sales receipt.
|
|
1928
|
+
*/
|
|
1929
|
+
lines?: Array<SalesReceiptCreateParams.Line>;
|
|
1930
|
+
/**
|
|
1931
|
+
* Body param: A memo or note for this sales receipt that appears in reports, but
|
|
1932
|
+
* not on the sales receipt.
|
|
1933
|
+
*/
|
|
1934
|
+
memo?: string;
|
|
1935
|
+
/**
|
|
1936
|
+
* Body param: A built-in custom field for additional information specific to this
|
|
1937
|
+
* sales receipt. Unlike the user-defined fields in the `customFields` array, this
|
|
1938
|
+
* is a standard QuickBooks field that exists for all sales receipts for
|
|
1939
|
+
* convenience. Developers often use this field for tracking information that
|
|
1940
|
+
* doesn't fit into other standard QuickBooks fields. Unlike `otherCustomField1`
|
|
1941
|
+
* and `otherCustomField2`, which are line item fields, this exists at the
|
|
1942
|
+
* transaction level. Hidden by default in the QuickBooks UI.
|
|
1943
|
+
*/
|
|
1944
|
+
otherCustomField?: string;
|
|
1945
|
+
/**
|
|
1946
|
+
* Body param: The sales receipt's payment method (e.g., cash, check, credit card).
|
|
1947
|
+
*
|
|
1948
|
+
* **NOTE**: If this sales receipt contains credit card transaction data supplied
|
|
1949
|
+
* from QuickBooks Merchant Services (QBMS) transaction responses, you must specify
|
|
1950
|
+
* a credit card payment method (e.g., "Visa", "MasterCard", etc.).
|
|
1951
|
+
*/
|
|
1952
|
+
paymentMethodId?: string;
|
|
1953
|
+
/**
|
|
1954
|
+
* Body param: The case-sensitive user-defined reference number for this sales
|
|
1955
|
+
* receipt, which can be used to identify the transaction in QuickBooks. This value
|
|
1956
|
+
* is not required to be unique and can be arbitrarily changed by the QuickBooks
|
|
1957
|
+
* user. When left blank in this create request, this field will be left blank in
|
|
1958
|
+
* QuickBooks (i.e., it does _not_ auto-increment).
|
|
1959
|
+
*/
|
|
1960
|
+
refNumber?: string;
|
|
1961
|
+
/**
|
|
1962
|
+
* Body param: The sales receipt's sales representative. Sales representatives can
|
|
1963
|
+
* be employees, vendors, or other names in QuickBooks.
|
|
1964
|
+
*/
|
|
1965
|
+
salesRepresentativeId?: string;
|
|
1966
|
+
/**
|
|
1967
|
+
* Body param: The sales-tax code for this sales receipt, determining whether it is
|
|
1968
|
+
* taxable or non-taxable. This can be overridden at the transaction-line level.
|
|
1969
|
+
*
|
|
1970
|
+
* Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
|
|
1971
|
+
* can also be created in QuickBooks. If QuickBooks is not set up to charge sales
|
|
1972
|
+
* tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
|
|
1973
|
+
* non-taxable code to all sales.
|
|
1974
|
+
*/
|
|
1975
|
+
salesTaxCodeId?: string;
|
|
1976
|
+
/**
|
|
1977
|
+
* Body param: The sales-tax item used to calculate the actual tax amount for this
|
|
1978
|
+
* sales receipt's transactions by applying a specific tax rate collected for a
|
|
1979
|
+
* single tax agency. Unlike `salesTaxCode`, which only indicates general
|
|
1980
|
+
* taxability, this field drives the actual tax calculation and reporting.
|
|
1981
|
+
*
|
|
1982
|
+
* For sales receipts, while using this field to specify a single tax item/group
|
|
1983
|
+
* that applies uniformly is recommended, complex tax scenarios may require
|
|
1984
|
+
* alternative approaches. In such cases, you can set this field to a 0% tax item
|
|
1985
|
+
* (conventionally named "Tax Calculated On Invoice") and handle tax calculations
|
|
1986
|
+
* through line items instead. When using line items for taxes, note that only
|
|
1987
|
+
* individual tax items (not tax groups) can be used, subtotals can help apply a
|
|
1988
|
+
* tax to multiple items but only the first tax line after a subtotal is calculated
|
|
1989
|
+
* automatically (subsequent tax lines require manual amounts), and the rate column
|
|
1990
|
+
* will always display the actual tax amount rather than the rate percentage.
|
|
1991
|
+
*/
|
|
1992
|
+
salesTaxItemId?: string;
|
|
1993
|
+
/**
|
|
1994
|
+
* Body param: The origin location from where the product associated with this
|
|
1995
|
+
* sales receipt is shipped. This is the point at which ownership and liability for
|
|
1996
|
+
* goods transfer from seller to buyer. Internally, QuickBooks uses the term "FOB"
|
|
1997
|
+
* for this field, which stands for "freight on board". This field is informational
|
|
1998
|
+
* and has no accounting implications.
|
|
1999
|
+
*/
|
|
2000
|
+
shipmentOrigin?: string;
|
|
2001
|
+
/**
|
|
2002
|
+
* Body param: The sales receipt's shipping address.
|
|
2003
|
+
*/
|
|
2004
|
+
shippingAddress?: SalesReceiptCreateParams.ShippingAddress;
|
|
2005
|
+
/**
|
|
2006
|
+
* Body param: The date when the products or services for this sales receipt were
|
|
2007
|
+
* shipped or are expected to be shipped, in ISO 8601 format (YYYY-MM-DD).
|
|
2008
|
+
*/
|
|
2009
|
+
shippingDate?: string;
|
|
2010
|
+
/**
|
|
2011
|
+
* Body param: The shipping method used for this sales receipt, such as standard
|
|
2012
|
+
* mail or overnight delivery.
|
|
2013
|
+
*/
|
|
2014
|
+
shippingMethodId?: string;
|
|
2015
|
+
}
|
|
2016
|
+
export declare namespace SalesReceiptCreateParams {
|
|
2017
|
+
/**
|
|
2018
|
+
* The sales receipt's billing address.
|
|
2019
|
+
*/
|
|
2020
|
+
interface BillingAddress {
|
|
2021
|
+
/**
|
|
2022
|
+
* The city, district, suburb, town, or village name of the address.
|
|
2023
|
+
*
|
|
2024
|
+
* Maximum length: 31 characters.
|
|
2025
|
+
*/
|
|
2026
|
+
city?: string;
|
|
2027
|
+
/**
|
|
2028
|
+
* The country name of the address.
|
|
2029
|
+
*/
|
|
2030
|
+
country?: string;
|
|
2031
|
+
/**
|
|
2032
|
+
* The first line of the address (e.g., street, PO Box, or company name).
|
|
2033
|
+
*
|
|
2034
|
+
* Maximum length: 41 characters.
|
|
2035
|
+
*/
|
|
2036
|
+
line1?: string;
|
|
2037
|
+
/**
|
|
2038
|
+
* The second line of the address, if needed (e.g., apartment, suite, unit, or
|
|
2039
|
+
* building).
|
|
2040
|
+
*
|
|
2041
|
+
* Maximum length: 41 characters.
|
|
2042
|
+
*/
|
|
2043
|
+
line2?: string;
|
|
2044
|
+
/**
|
|
2045
|
+
* The third line of the address, if needed.
|
|
2046
|
+
*
|
|
2047
|
+
* Maximum length: 41 characters.
|
|
2048
|
+
*/
|
|
2049
|
+
line3?: string;
|
|
2050
|
+
/**
|
|
2051
|
+
* The fourth line of the address, if needed.
|
|
2052
|
+
*
|
|
2053
|
+
* Maximum length: 41 characters.
|
|
2054
|
+
*/
|
|
2055
|
+
line4?: string;
|
|
2056
|
+
/**
|
|
2057
|
+
* The fifth line of the address, if needed.
|
|
2058
|
+
*
|
|
2059
|
+
* Maximum length: 41 characters.
|
|
2060
|
+
*/
|
|
2061
|
+
line5?: string;
|
|
2062
|
+
/**
|
|
2063
|
+
* A note written at the bottom of the address in the form in which it appears,
|
|
2064
|
+
* such as the invoice form.
|
|
2065
|
+
*/
|
|
2066
|
+
note?: string;
|
|
2067
|
+
/**
|
|
2068
|
+
* The postal code or ZIP code of the address.
|
|
2069
|
+
*
|
|
2070
|
+
* Maximum length: 13 characters.
|
|
2071
|
+
*/
|
|
2072
|
+
postalCode?: string;
|
|
2073
|
+
/**
|
|
2074
|
+
* The state, county, province, or region name of the address.
|
|
2075
|
+
*
|
|
2076
|
+
* Maximum length: 21 characters.
|
|
2077
|
+
*/
|
|
2078
|
+
state?: string;
|
|
2079
|
+
}
|
|
2080
|
+
/**
|
|
2081
|
+
* The credit card transaction data for this sales receipt's payment when using
|
|
2082
|
+
* QuickBooks Merchant Services (QBMS). If specifying this field, you must also
|
|
2083
|
+
* specify the `paymentMethod` field.
|
|
2084
|
+
*/
|
|
2085
|
+
interface CreditCardTransaction {
|
|
2086
|
+
/**
|
|
2087
|
+
* The transaction request data originally supplied for this credit card
|
|
2088
|
+
* transaction when using QuickBooks Merchant Services (QBMS).
|
|
2089
|
+
*/
|
|
2090
|
+
request?: CreditCardTransaction.Request;
|
|
2091
|
+
/**
|
|
2092
|
+
* The transaction response data for this credit card transaction when using
|
|
2093
|
+
* QuickBooks Merchant Services (QBMS).
|
|
2094
|
+
*/
|
|
2095
|
+
response?: CreditCardTransaction.Response;
|
|
2096
|
+
}
|
|
2097
|
+
namespace CreditCardTransaction {
|
|
2098
|
+
/**
|
|
2099
|
+
* The transaction request data originally supplied for this credit card
|
|
2100
|
+
* transaction when using QuickBooks Merchant Services (QBMS).
|
|
2101
|
+
*/
|
|
2102
|
+
interface Request {
|
|
2103
|
+
/**
|
|
2104
|
+
* The month when the credit card expires.
|
|
2105
|
+
*/
|
|
2106
|
+
expirationMonth: number;
|
|
2107
|
+
/**
|
|
2108
|
+
* The year when the credit card expires.
|
|
2109
|
+
*/
|
|
2110
|
+
expirationYear: number;
|
|
2111
|
+
/**
|
|
2112
|
+
* The cardholder's name on the card.
|
|
2113
|
+
*/
|
|
2114
|
+
name: string;
|
|
2115
|
+
/**
|
|
2116
|
+
* The credit card number. Must be masked with lower case "x" and no dashes.
|
|
2117
|
+
*/
|
|
2118
|
+
number: string;
|
|
2119
|
+
/**
|
|
2120
|
+
* The card's billing address.
|
|
2121
|
+
*/
|
|
2122
|
+
address?: string;
|
|
2123
|
+
/**
|
|
2124
|
+
* The commercial card code identifies the type of business credit card being used
|
|
2125
|
+
* (purchase, corporate, or business) for Visa and Mastercard transactions only.
|
|
2126
|
+
* When provided, this code may qualify the transaction for lower processing fees
|
|
2127
|
+
* compared to the standard rates that apply when no code is specified.
|
|
2128
|
+
*/
|
|
2129
|
+
commercialCardCode?: string;
|
|
2130
|
+
/**
|
|
2131
|
+
* The card's billing address ZIP or postal code.
|
|
2132
|
+
*/
|
|
2133
|
+
postalCode?: string;
|
|
2134
|
+
/**
|
|
2135
|
+
* Indicates whether this credit card transaction came from a card swipe
|
|
2136
|
+
* (`card_present`) or not (`card_not_present`).
|
|
2137
|
+
*/
|
|
2138
|
+
transactionMode?: 'card_not_present' | 'card_present';
|
|
2139
|
+
/**
|
|
2140
|
+
* The QBMS transaction type from which the current transaction data originated.
|
|
2141
|
+
*/
|
|
2142
|
+
transactionType?: 'authorization' | 'capture' | 'charge' | 'refund' | 'voice_authorization';
|
|
2143
|
+
}
|
|
2144
|
+
/**
|
|
2145
|
+
* The transaction response data for this credit card transaction when using
|
|
2146
|
+
* QuickBooks Merchant Services (QBMS).
|
|
2147
|
+
*/
|
|
2148
|
+
interface Response {
|
|
2149
|
+
/**
|
|
2150
|
+
* The ID returned from the credit card processor for this credit card transaction.
|
|
2151
|
+
*/
|
|
2152
|
+
creditCardTransactionId: string;
|
|
2153
|
+
/**
|
|
2154
|
+
* The QBMS account number of the merchant who is running this transaction using
|
|
2155
|
+
* the customer's credit card.
|
|
2156
|
+
*/
|
|
2157
|
+
merchantAccountNumber: string;
|
|
2158
|
+
/**
|
|
2159
|
+
* Indicates whether this credit card transaction is known to have been
|
|
2160
|
+
* successfully processed by the card issuer.
|
|
2161
|
+
*/
|
|
2162
|
+
paymentStatus: 'completed' | 'unknown';
|
|
2163
|
+
/**
|
|
2164
|
+
* The status code returned in the original QBMS transaction response for this
|
|
2165
|
+
* credit card transaction.
|
|
2166
|
+
*/
|
|
2167
|
+
statusCode: number;
|
|
2168
|
+
/**
|
|
2169
|
+
* The status message returned in the original QBMS transaction response for this
|
|
2170
|
+
* credit card transaction.
|
|
2171
|
+
*/
|
|
2172
|
+
statusMessage: string;
|
|
2173
|
+
/**
|
|
2174
|
+
* The date and time when the credit card processor authorized this credit card
|
|
2175
|
+
* transaction.
|
|
2176
|
+
*/
|
|
2177
|
+
transactionAuthorizedAt: string;
|
|
2178
|
+
/**
|
|
2179
|
+
* The authorization code returned from the credit card processor to indicate that
|
|
2180
|
+
* this charge will be paid by the card issuer.
|
|
2181
|
+
*/
|
|
2182
|
+
authorizationCode?: string;
|
|
2183
|
+
/**
|
|
2184
|
+
* Indicates whether the street address supplied in the transaction request matches
|
|
2185
|
+
* the customer's address on file at the card issuer.
|
|
2186
|
+
*/
|
|
2187
|
+
avsStreetStatus?: 'fail' | 'not_available' | 'pass';
|
|
2188
|
+
/**
|
|
2189
|
+
* Indicates whether the customer postal ZIP code supplied in the transaction
|
|
2190
|
+
* request matches the customer's postal code recognized at the card issuer.
|
|
2191
|
+
*/
|
|
2192
|
+
avsZipStatus?: 'fail' | 'not_available' | 'pass';
|
|
2193
|
+
/**
|
|
2194
|
+
* Indicates whether the card security code supplied in the transaction request
|
|
2195
|
+
* matches the card security code recognized for that credit card number at the
|
|
2196
|
+
* card issuer.
|
|
2197
|
+
*/
|
|
2198
|
+
cardSecurityCodeMatch?: 'fail' | 'not_available' | 'pass';
|
|
2199
|
+
/**
|
|
2200
|
+
* A value returned from QBMS transactions for future use by the QuickBooks
|
|
2201
|
+
* Reconciliation feature.
|
|
2202
|
+
*/
|
|
2203
|
+
clientTransactionId?: string;
|
|
2204
|
+
/**
|
|
2205
|
+
* An internal code returned by QuickBooks Merchant Services (QBMS) from the
|
|
2206
|
+
* transaction request, needed for the QuickBooks reconciliation feature.
|
|
2207
|
+
*/
|
|
2208
|
+
paymentGroupingCode?: number;
|
|
2209
|
+
/**
|
|
2210
|
+
* An internal ID returned by QuickBooks Merchant Services (QBMS) from the
|
|
2211
|
+
* transaction request, needed for the QuickBooks reconciliation feature.
|
|
2212
|
+
*/
|
|
2213
|
+
reconBatchId?: string;
|
|
2214
|
+
/**
|
|
2215
|
+
* An internal value for this credit card transaction, needed for the QuickBooks
|
|
2216
|
+
* reconciliation feature.
|
|
2217
|
+
*/
|
|
2218
|
+
transactionAuthorizationStamp?: number;
|
|
2219
|
+
}
|
|
2220
|
+
}
|
|
2221
|
+
interface LineGroup {
|
|
2222
|
+
/**
|
|
2223
|
+
* The sales receipt line group's item group, representing a predefined set of
|
|
2224
|
+
* items bundled because they are commonly purchased together or grouped for faster
|
|
2225
|
+
* entry.
|
|
2226
|
+
*/
|
|
2227
|
+
itemGroupId: string;
|
|
2228
|
+
/**
|
|
2229
|
+
* The custom fields for the sales receipt line group object, added as user-defined
|
|
2230
|
+
* data extensions, not included in the standard QuickBooks object.
|
|
2231
|
+
*/
|
|
2232
|
+
customFields?: Array<LineGroup.CustomField>;
|
|
2233
|
+
/**
|
|
2234
|
+
* The site location where inventory for the item group associated with this sales
|
|
2235
|
+
* receipt line group is stored.
|
|
2236
|
+
*/
|
|
2237
|
+
inventorySiteId?: string;
|
|
2238
|
+
/**
|
|
2239
|
+
* The specific location (e.g., bin or shelf) within the inventory site where the
|
|
2240
|
+
* item group associated with this sales receipt line group is stored.
|
|
2241
|
+
*/
|
|
2242
|
+
inventorySiteLocationId?: string;
|
|
2243
|
+
/**
|
|
2244
|
+
* The quantity of the item group associated with this sales receipt line group.
|
|
2245
|
+
* This field cannot be cleared.
|
|
2246
|
+
*
|
|
2247
|
+
* **NOTE**: Do not use this field if the associated item group is a discount item
|
|
2248
|
+
* group.
|
|
2249
|
+
*/
|
|
2250
|
+
quantity?: number;
|
|
2251
|
+
/**
|
|
2252
|
+
* The unit-of-measure used for the `quantity` in this sales receipt line group.
|
|
2253
|
+
* Must be a valid unit within the item's available units of measure.
|
|
2254
|
+
*/
|
|
2255
|
+
unitOfMeasure?: string;
|
|
2256
|
+
}
|
|
2257
|
+
namespace LineGroup {
|
|
2258
|
+
interface CustomField {
|
|
2259
|
+
/**
|
|
2260
|
+
* The name of the custom field, unique for the specified `ownerId`. For public
|
|
2261
|
+
* custom fields, this name is visible as a label in the QuickBooks UI.
|
|
2262
|
+
*/
|
|
2263
|
+
name: string;
|
|
2264
|
+
/**
|
|
2265
|
+
* The identifier of the owner of the custom field, which QuickBooks internally
|
|
2266
|
+
* calls a "data extension". For public custom fields visible in the UI, such as
|
|
2267
|
+
* those added by the QuickBooks user, this is always "0". For private custom
|
|
2268
|
+
* fields that are only visible to the application that created them, this is a
|
|
2269
|
+
* valid GUID identifying the owning application. Internally, Conductor always
|
|
2270
|
+
* fetches all public custom fields (those with an `ownerId` of "0") for all
|
|
2271
|
+
* objects.
|
|
2272
|
+
*/
|
|
2273
|
+
ownerId: string;
|
|
2274
|
+
/**
|
|
2275
|
+
* The value of this custom field. The maximum length depends on the field's data
|
|
2276
|
+
* type.
|
|
2277
|
+
*/
|
|
2278
|
+
value: string;
|
|
2279
|
+
}
|
|
2280
|
+
}
|
|
2281
|
+
interface Line {
|
|
2282
|
+
/**
|
|
2283
|
+
* The monetary amount of this sales receipt line, represented as a decimal string.
|
|
2284
|
+
* If both `quantity` and `rate` are specified but not `amount`, QuickBooks will
|
|
2285
|
+
* use them to calculate `amount`. If `amount`, `rate`, and `quantity` are all
|
|
2286
|
+
* unspecified, then QuickBooks will calculate `amount` based on a `quantity` of
|
|
2287
|
+
* `1` and the suggested `rate`. This field cannot be cleared.
|
|
2288
|
+
*/
|
|
2289
|
+
amount?: string;
|
|
2290
|
+
/**
|
|
2291
|
+
* The sales receipt line's class. Classes can be used to categorize objects into
|
|
2292
|
+
* meaningful segments, such as department, location, or type of work. In
|
|
2293
|
+
* QuickBooks, class tracking is off by default. If a class is specified for the
|
|
2294
|
+
* entire parent transaction, it is automatically applied to all sales receipt
|
|
2295
|
+
* lines unless overridden here, at the transaction line level.
|
|
2296
|
+
*/
|
|
2297
|
+
classId?: string;
|
|
2298
|
+
/**
|
|
2299
|
+
* The credit card transaction data for this sales receipt line's payment when
|
|
2300
|
+
* using QuickBooks Merchant Services (QBMS). If specifying this field, you must
|
|
2301
|
+
* also specify the `paymentMethod` field.
|
|
2302
|
+
*/
|
|
2303
|
+
creditCardTransaction?: Line.CreditCardTransaction;
|
|
2304
|
+
/**
|
|
2305
|
+
* The custom fields for the sales receipt line object, added as user-defined data
|
|
2306
|
+
* extensions, not included in the standard QuickBooks object.
|
|
2307
|
+
*/
|
|
2308
|
+
customFields?: Array<Line.CustomField>;
|
|
2309
|
+
/**
|
|
2310
|
+
* A description of this sales receipt line.
|
|
2311
|
+
*/
|
|
2312
|
+
description?: string;
|
|
2313
|
+
/**
|
|
2314
|
+
* The site location where inventory for the item associated with this sales
|
|
2315
|
+
* receipt line is stored.
|
|
2316
|
+
*/
|
|
2317
|
+
inventorySiteId?: string;
|
|
2318
|
+
/**
|
|
2319
|
+
* The specific location (e.g., bin or shelf) within the inventory site where the
|
|
2320
|
+
* item associated with this sales receipt line is stored.
|
|
2321
|
+
*/
|
|
2322
|
+
inventorySiteLocationId?: string;
|
|
2323
|
+
/**
|
|
2324
|
+
* The item associated with this sales receipt line. This can refer to any good or
|
|
2325
|
+
* service that the business buys or sells, including item types such as a service
|
|
2326
|
+
* item, inventory item, or special calculation item like a discount item or
|
|
2327
|
+
* sales-tax item.
|
|
2328
|
+
*/
|
|
2329
|
+
itemId?: string;
|
|
2330
|
+
/**
|
|
2331
|
+
* The lot number of the item associated with this sales receipt line. Used for
|
|
2332
|
+
* tracking groups of inventory items that are purchased or manufactured together.
|
|
2333
|
+
*/
|
|
2334
|
+
lotNumber?: string;
|
|
2335
|
+
/**
|
|
2336
|
+
* A built-in custom field for additional information specific to this sales
|
|
2337
|
+
* receipt line. Unlike the user-defined fields in the `customFields` array, this
|
|
2338
|
+
* is a standard QuickBooks field that exists for all sales receipt lines for
|
|
2339
|
+
* convenience. Developers often use this field for tracking information that
|
|
2340
|
+
* doesn't fit into other standard QuickBooks fields. Hidden by default in the
|
|
2341
|
+
* QuickBooks UI.
|
|
2342
|
+
*/
|
|
2343
|
+
otherCustomField1?: string;
|
|
2344
|
+
/**
|
|
2345
|
+
* A second built-in custom field for additional information specific to this sales
|
|
2346
|
+
* receipt line. Unlike the user-defined fields in the `customFields` array, this
|
|
2347
|
+
* is a standard QuickBooks field that exists for all sales receipt lines for
|
|
2348
|
+
* convenience. Like `otherCustomField1`, developers often use this field for
|
|
2349
|
+
* tracking information that doesn't fit into other standard QuickBooks fields.
|
|
2350
|
+
* Hidden by default in the QuickBooks UI.
|
|
2351
|
+
*/
|
|
2352
|
+
otherCustomField2?: string;
|
|
2353
|
+
/**
|
|
2354
|
+
* The account to use for this sales receipt line, overriding the default account
|
|
2355
|
+
* associated with the item.
|
|
2356
|
+
*/
|
|
2357
|
+
overrideItemAccountId?: string;
|
|
2358
|
+
/**
|
|
2359
|
+
* The price level applied to this sales receipt line. This overrides any price
|
|
2360
|
+
* level set on the corresponding customer. The resulting sales receipt line will
|
|
2361
|
+
* not show this price level, only the final `rate` calculated from it.
|
|
2362
|
+
*/
|
|
2363
|
+
priceLevelId?: string;
|
|
2364
|
+
/**
|
|
2365
|
+
* Specifies how to resolve price rule conflicts when adding or modifying this
|
|
2366
|
+
* sales receipt line.
|
|
2367
|
+
*/
|
|
2368
|
+
priceRuleConflictStrategy?: 'base_price' | 'zero';
|
|
2369
|
+
/**
|
|
2370
|
+
* The quantity of the item associated with this sales receipt line. This field
|
|
2371
|
+
* cannot be cleared.
|
|
2372
|
+
*
|
|
2373
|
+
* **NOTE**: Do not use this field if the associated item is a discount item.
|
|
2374
|
+
*/
|
|
2375
|
+
quantity?: number;
|
|
2376
|
+
/**
|
|
2377
|
+
* The price per unit for this sales receipt line. If both `rate` and `amount` are
|
|
2378
|
+
* specified, `rate` will be ignored. If both `quantity` and `amount` are specified
|
|
2379
|
+
* but not `rate`, QuickBooks will use them to calculate `rate`. Represented as a
|
|
2380
|
+
* decimal string. This field cannot be cleared.
|
|
2381
|
+
*/
|
|
2382
|
+
rate?: string;
|
|
2383
|
+
/**
|
|
2384
|
+
* The price of this sales receipt line expressed as a percentage. Typically used
|
|
2385
|
+
* for discount or markup items.
|
|
2386
|
+
*/
|
|
2387
|
+
ratePercent?: string;
|
|
2388
|
+
/**
|
|
2389
|
+
* The sales-tax code for this sales receipt line, determining whether it is
|
|
2390
|
+
* taxable or non-taxable. If set, this overrides any sales-tax codes defined on
|
|
2391
|
+
* the parent transaction or the associated item.
|
|
2392
|
+
*
|
|
2393
|
+
* Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
|
|
2394
|
+
* can also be created in QuickBooks. If QuickBooks is not set up to charge sales
|
|
2395
|
+
* tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
|
|
2396
|
+
* non-taxable code to all sales.
|
|
2397
|
+
*/
|
|
2398
|
+
salesTaxCodeId?: string;
|
|
2399
|
+
/**
|
|
2400
|
+
* The serial number of the item associated with this sales receipt line. This is
|
|
2401
|
+
* used for tracking individual units of serialized inventory items.
|
|
2402
|
+
*/
|
|
2403
|
+
serialNumber?: string;
|
|
2404
|
+
/**
|
|
2405
|
+
* The date on which the service for this sales receipt line was or will be
|
|
2406
|
+
* performed, in ISO 8601 format (YYYY-MM-DD). This is particularly relevant for
|
|
2407
|
+
* service items.
|
|
2408
|
+
*/
|
|
2409
|
+
serviceDate?: string;
|
|
2410
|
+
/**
|
|
2411
|
+
* The unit-of-measure used for the `quantity` in this sales receipt line. Must be
|
|
2412
|
+
* a valid unit within the item's available units of measure.
|
|
2413
|
+
*/
|
|
2414
|
+
unitOfMeasure?: string;
|
|
2415
|
+
}
|
|
2416
|
+
namespace Line {
|
|
2417
|
+
/**
|
|
2418
|
+
* The credit card transaction data for this sales receipt line's payment when
|
|
2419
|
+
* using QuickBooks Merchant Services (QBMS). If specifying this field, you must
|
|
2420
|
+
* also specify the `paymentMethod` field.
|
|
2421
|
+
*/
|
|
2422
|
+
interface CreditCardTransaction {
|
|
2423
|
+
/**
|
|
2424
|
+
* The transaction request data originally supplied for this credit card
|
|
2425
|
+
* transaction when using QuickBooks Merchant Services (QBMS).
|
|
2426
|
+
*/
|
|
2427
|
+
request?: CreditCardTransaction.Request;
|
|
2428
|
+
/**
|
|
2429
|
+
* The transaction response data for this credit card transaction when using
|
|
2430
|
+
* QuickBooks Merchant Services (QBMS).
|
|
2431
|
+
*/
|
|
2432
|
+
response?: CreditCardTransaction.Response;
|
|
2433
|
+
}
|
|
2434
|
+
namespace CreditCardTransaction {
|
|
2435
|
+
/**
|
|
2436
|
+
* The transaction request data originally supplied for this credit card
|
|
2437
|
+
* transaction when using QuickBooks Merchant Services (QBMS).
|
|
2438
|
+
*/
|
|
2439
|
+
interface Request {
|
|
2440
|
+
/**
|
|
2441
|
+
* The month when the credit card expires.
|
|
2442
|
+
*/
|
|
2443
|
+
expirationMonth: number;
|
|
2444
|
+
/**
|
|
2445
|
+
* The year when the credit card expires.
|
|
2446
|
+
*/
|
|
2447
|
+
expirationYear: number;
|
|
2448
|
+
/**
|
|
2449
|
+
* The cardholder's name on the card.
|
|
2450
|
+
*/
|
|
2451
|
+
name: string;
|
|
2452
|
+
/**
|
|
2453
|
+
* The credit card number. Must be masked with lower case "x" and no dashes.
|
|
2454
|
+
*/
|
|
2455
|
+
number: string;
|
|
2456
|
+
/**
|
|
2457
|
+
* The card's billing address.
|
|
2458
|
+
*/
|
|
2459
|
+
address?: string;
|
|
2460
|
+
/**
|
|
2461
|
+
* The commercial card code identifies the type of business credit card being used
|
|
2462
|
+
* (purchase, corporate, or business) for Visa and Mastercard transactions only.
|
|
2463
|
+
* When provided, this code may qualify the transaction for lower processing fees
|
|
2464
|
+
* compared to the standard rates that apply when no code is specified.
|
|
2465
|
+
*/
|
|
2466
|
+
commercialCardCode?: string;
|
|
2467
|
+
/**
|
|
2468
|
+
* The card's billing address ZIP or postal code.
|
|
2469
|
+
*/
|
|
2470
|
+
postalCode?: string;
|
|
2471
|
+
/**
|
|
2472
|
+
* Indicates whether this credit card transaction came from a card swipe
|
|
2473
|
+
* (`card_present`) or not (`card_not_present`).
|
|
2474
|
+
*/
|
|
2475
|
+
transactionMode?: 'card_not_present' | 'card_present';
|
|
2476
|
+
/**
|
|
2477
|
+
* The QBMS transaction type from which the current transaction data originated.
|
|
2478
|
+
*/
|
|
2479
|
+
transactionType?: 'authorization' | 'capture' | 'charge' | 'refund' | 'voice_authorization';
|
|
2480
|
+
}
|
|
2481
|
+
/**
|
|
2482
|
+
* The transaction response data for this credit card transaction when using
|
|
2483
|
+
* QuickBooks Merchant Services (QBMS).
|
|
2484
|
+
*/
|
|
2485
|
+
interface Response {
|
|
2486
|
+
/**
|
|
2487
|
+
* The ID returned from the credit card processor for this credit card transaction.
|
|
2488
|
+
*/
|
|
2489
|
+
creditCardTransactionId: string;
|
|
2490
|
+
/**
|
|
2491
|
+
* The QBMS account number of the merchant who is running this transaction using
|
|
2492
|
+
* the customer's credit card.
|
|
2493
|
+
*/
|
|
2494
|
+
merchantAccountNumber: string;
|
|
2495
|
+
/**
|
|
2496
|
+
* Indicates whether this credit card transaction is known to have been
|
|
2497
|
+
* successfully processed by the card issuer.
|
|
2498
|
+
*/
|
|
2499
|
+
paymentStatus: 'completed' | 'unknown';
|
|
2500
|
+
/**
|
|
2501
|
+
* The status code returned in the original QBMS transaction response for this
|
|
2502
|
+
* credit card transaction.
|
|
2503
|
+
*/
|
|
2504
|
+
statusCode: number;
|
|
2505
|
+
/**
|
|
2506
|
+
* The status message returned in the original QBMS transaction response for this
|
|
2507
|
+
* credit card transaction.
|
|
2508
|
+
*/
|
|
2509
|
+
statusMessage: string;
|
|
2510
|
+
/**
|
|
2511
|
+
* The date and time when the credit card processor authorized this credit card
|
|
2512
|
+
* transaction.
|
|
2513
|
+
*/
|
|
2514
|
+
transactionAuthorizedAt: string;
|
|
2515
|
+
/**
|
|
2516
|
+
* The authorization code returned from the credit card processor to indicate that
|
|
2517
|
+
* this charge will be paid by the card issuer.
|
|
2518
|
+
*/
|
|
2519
|
+
authorizationCode?: string;
|
|
2520
|
+
/**
|
|
2521
|
+
* Indicates whether the street address supplied in the transaction request matches
|
|
2522
|
+
* the customer's address on file at the card issuer.
|
|
2523
|
+
*/
|
|
2524
|
+
avsStreetStatus?: 'fail' | 'not_available' | 'pass';
|
|
2525
|
+
/**
|
|
2526
|
+
* Indicates whether the customer postal ZIP code supplied in the transaction
|
|
2527
|
+
* request matches the customer's postal code recognized at the card issuer.
|
|
2528
|
+
*/
|
|
2529
|
+
avsZipStatus?: 'fail' | 'not_available' | 'pass';
|
|
2530
|
+
/**
|
|
2531
|
+
* Indicates whether the card security code supplied in the transaction request
|
|
2532
|
+
* matches the card security code recognized for that credit card number at the
|
|
2533
|
+
* card issuer.
|
|
2534
|
+
*/
|
|
2535
|
+
cardSecurityCodeMatch?: 'fail' | 'not_available' | 'pass';
|
|
2536
|
+
/**
|
|
2537
|
+
* A value returned from QBMS transactions for future use by the QuickBooks
|
|
2538
|
+
* Reconciliation feature.
|
|
2539
|
+
*/
|
|
2540
|
+
clientTransactionId?: string;
|
|
2541
|
+
/**
|
|
2542
|
+
* An internal code returned by QuickBooks Merchant Services (QBMS) from the
|
|
2543
|
+
* transaction request, needed for the QuickBooks reconciliation feature.
|
|
2544
|
+
*/
|
|
2545
|
+
paymentGroupingCode?: number;
|
|
2546
|
+
/**
|
|
2547
|
+
* An internal ID returned by QuickBooks Merchant Services (QBMS) from the
|
|
2548
|
+
* transaction request, needed for the QuickBooks reconciliation feature.
|
|
2549
|
+
*/
|
|
2550
|
+
reconBatchId?: string;
|
|
2551
|
+
/**
|
|
2552
|
+
* An internal value for this credit card transaction, needed for the QuickBooks
|
|
2553
|
+
* reconciliation feature.
|
|
2554
|
+
*/
|
|
2555
|
+
transactionAuthorizationStamp?: number;
|
|
2556
|
+
}
|
|
2557
|
+
}
|
|
2558
|
+
interface CustomField {
|
|
2559
|
+
/**
|
|
2560
|
+
* The name of the custom field, unique for the specified `ownerId`. For public
|
|
2561
|
+
* custom fields, this name is visible as a label in the QuickBooks UI.
|
|
2562
|
+
*/
|
|
2563
|
+
name: string;
|
|
2564
|
+
/**
|
|
2565
|
+
* The identifier of the owner of the custom field, which QuickBooks internally
|
|
2566
|
+
* calls a "data extension". For public custom fields visible in the UI, such as
|
|
2567
|
+
* those added by the QuickBooks user, this is always "0". For private custom
|
|
2568
|
+
* fields that are only visible to the application that created them, this is a
|
|
2569
|
+
* valid GUID identifying the owning application. Internally, Conductor always
|
|
2570
|
+
* fetches all public custom fields (those with an `ownerId` of "0") for all
|
|
2571
|
+
* objects.
|
|
2572
|
+
*/
|
|
2573
|
+
ownerId: string;
|
|
2574
|
+
/**
|
|
2575
|
+
* The value of this custom field. The maximum length depends on the field's data
|
|
2576
|
+
* type.
|
|
2577
|
+
*/
|
|
2578
|
+
value: string;
|
|
2579
|
+
}
|
|
2580
|
+
}
|
|
2581
|
+
/**
|
|
2582
|
+
* The sales receipt's shipping address.
|
|
2583
|
+
*/
|
|
2584
|
+
interface ShippingAddress {
|
|
2585
|
+
/**
|
|
2586
|
+
* The city, district, suburb, town, or village name of the address.
|
|
2587
|
+
*
|
|
2588
|
+
* Maximum length: 31 characters.
|
|
2589
|
+
*/
|
|
2590
|
+
city?: string;
|
|
2591
|
+
/**
|
|
2592
|
+
* The country name of the address.
|
|
2593
|
+
*/
|
|
2594
|
+
country?: string;
|
|
2595
|
+
/**
|
|
2596
|
+
* The first line of the address (e.g., street, PO Box, or company name).
|
|
2597
|
+
*
|
|
2598
|
+
* Maximum length: 41 characters.
|
|
2599
|
+
*/
|
|
2600
|
+
line1?: string;
|
|
2601
|
+
/**
|
|
2602
|
+
* The second line of the address, if needed (e.g., apartment, suite, unit, or
|
|
2603
|
+
* building).
|
|
2604
|
+
*
|
|
2605
|
+
* Maximum length: 41 characters.
|
|
2606
|
+
*/
|
|
2607
|
+
line2?: string;
|
|
2608
|
+
/**
|
|
2609
|
+
* The third line of the address, if needed.
|
|
2610
|
+
*
|
|
2611
|
+
* Maximum length: 41 characters.
|
|
2612
|
+
*/
|
|
2613
|
+
line3?: string;
|
|
2614
|
+
/**
|
|
2615
|
+
* The fourth line of the address, if needed.
|
|
2616
|
+
*
|
|
2617
|
+
* Maximum length: 41 characters.
|
|
2618
|
+
*/
|
|
2619
|
+
line4?: string;
|
|
2620
|
+
/**
|
|
2621
|
+
* The fifth line of the address, if needed.
|
|
2622
|
+
*
|
|
2623
|
+
* Maximum length: 41 characters.
|
|
2624
|
+
*/
|
|
2625
|
+
line5?: string;
|
|
2626
|
+
/**
|
|
2627
|
+
* A note written at the bottom of the address in the form in which it appears,
|
|
2628
|
+
* such as the invoice form.
|
|
2629
|
+
*/
|
|
2630
|
+
note?: string;
|
|
2631
|
+
/**
|
|
2632
|
+
* The postal code or ZIP code of the address.
|
|
2633
|
+
*
|
|
2634
|
+
* Maximum length: 13 characters.
|
|
2635
|
+
*/
|
|
2636
|
+
postalCode?: string;
|
|
2637
|
+
/**
|
|
2638
|
+
* The state, county, province, or region name of the address.
|
|
2639
|
+
*
|
|
2640
|
+
* Maximum length: 21 characters.
|
|
2641
|
+
*/
|
|
2642
|
+
state?: string;
|
|
2643
|
+
}
|
|
2644
|
+
}
|
|
2645
|
+
export interface SalesReceiptRetrieveParams {
|
|
2646
|
+
/**
|
|
2647
|
+
* The ID of the End-User to receive this request.
|
|
2648
|
+
*/
|
|
2649
|
+
conductorEndUserId: string;
|
|
2650
|
+
}
|
|
2651
|
+
export interface SalesReceiptUpdateParams {
|
|
2652
|
+
/**
|
|
2653
|
+
* Body param: The current QuickBooks-assigned revision number of the sales receipt
|
|
2654
|
+
* object you are updating, which you can get by fetching the object first. Provide
|
|
2655
|
+
* the most recent `revisionNumber` to ensure you're working with the latest data;
|
|
2656
|
+
* otherwise, the update will return an error.
|
|
2657
|
+
*/
|
|
2658
|
+
revisionNumber: string;
|
|
2659
|
+
/**
|
|
2660
|
+
* Header param: The ID of the End-User to receive this request.
|
|
2661
|
+
*/
|
|
2662
|
+
conductorEndUserId: string;
|
|
2663
|
+
/**
|
|
2664
|
+
* Body param: The sales receipt's billing address.
|
|
2665
|
+
*/
|
|
2666
|
+
billingAddress?: SalesReceiptUpdateParams.BillingAddress;
|
|
2667
|
+
/**
|
|
2668
|
+
* Body param: The check number of a check received for this sales receipt.
|
|
2669
|
+
*/
|
|
2670
|
+
checkNumber?: string;
|
|
2671
|
+
/**
|
|
2672
|
+
* Body param: The sales receipt's class. Classes can be used to categorize objects
|
|
2673
|
+
* into meaningful segments, such as department, location, or type of work. In
|
|
2674
|
+
* QuickBooks, class tracking is off by default. A class defined here is
|
|
2675
|
+
* automatically used in this sales receipt's line items unless overridden at the
|
|
2676
|
+
* line item level.
|
|
2677
|
+
*/
|
|
2678
|
+
classId?: string;
|
|
2679
|
+
/**
|
|
2680
|
+
* Body param: The customer or customer-job to which the payment for this sales
|
|
2681
|
+
* receipt is credited.
|
|
2682
|
+
*/
|
|
2683
|
+
customerId?: string;
|
|
2684
|
+
/**
|
|
2685
|
+
* Body param: The message to display to the customer on the sales receipt.
|
|
2686
|
+
*/
|
|
2687
|
+
customerMessageId?: string;
|
|
2688
|
+
/**
|
|
2689
|
+
* Body param: The account where the funds for this sales receipt will be or have
|
|
2690
|
+
* been deposited.
|
|
2691
|
+
*/
|
|
2692
|
+
depositToAccountId?: string;
|
|
2693
|
+
/**
|
|
2694
|
+
* Body param: The predefined template in QuickBooks that determines the layout and
|
|
2695
|
+
* formatting for this sales receipt when printed or displayed.
|
|
2696
|
+
*/
|
|
2697
|
+
documentTemplateId?: string;
|
|
2698
|
+
/**
|
|
2699
|
+
* Body param: The date by which this sales receipt must be paid, in ISO 8601
|
|
2700
|
+
* format (YYYY-MM-DD).
|
|
2701
|
+
*
|
|
2702
|
+
* **NOTE**: For sales receipts, this field is often `null` because sales receipts
|
|
2703
|
+
* are generally used for point-of-sale payments, where full payment is received at
|
|
2704
|
+
* the time of purchase.
|
|
2705
|
+
*/
|
|
2706
|
+
dueDate?: string;
|
|
2707
|
+
/**
|
|
2708
|
+
* Body param: The market exchange rate between this sales receipt's currency and
|
|
2709
|
+
* the home currency in QuickBooks at the time of this transaction. Represented as
|
|
2710
|
+
* a decimal value (e.g., 1.2345 for 1 EUR = 1.2345 USD if USD is the home
|
|
2711
|
+
* currency).
|
|
2712
|
+
*/
|
|
2713
|
+
exchangeRate?: number;
|
|
2714
|
+
/**
|
|
2715
|
+
* Body param: Indicates whether this sales receipt has not been completed.
|
|
2716
|
+
*/
|
|
2717
|
+
isPending?: boolean;
|
|
2718
|
+
/**
|
|
2719
|
+
* Body param: Indicates whether this sales receipt is included in the queue of
|
|
2720
|
+
* documents for QuickBooks to email to the customer.
|
|
2721
|
+
*/
|
|
2722
|
+
isQueuedForEmail?: boolean;
|
|
2723
|
+
/**
|
|
2724
|
+
* Body param: Indicates whether this sales receipt is included in the queue of
|
|
2725
|
+
* documents for QuickBooks to print.
|
|
2726
|
+
*/
|
|
2727
|
+
isQueuedForPrint?: boolean;
|
|
2728
|
+
/**
|
|
2729
|
+
* Body param: The sales receipt's line item groups, each representing a predefined
|
|
2730
|
+
* set of related items.
|
|
2731
|
+
*
|
|
2732
|
+
* **IMPORTANT**:
|
|
2733
|
+
*
|
|
2734
|
+
* 1. Including this array in your update request will **REPLACE** all existing
|
|
2735
|
+
* line item groups for the sales receipt with this array. To keep any existing
|
|
2736
|
+
* line item groups, you must include them in this array even if they have not
|
|
2737
|
+
* changed. **Any line item groups not included will be removed.**
|
|
2738
|
+
*
|
|
2739
|
+
* 2. To add a new line item group, include it here with the `id` field set to
|
|
2740
|
+
* `-1`.
|
|
2741
|
+
*
|
|
2742
|
+
* 3. If you do not wish to modify any line item groups, omit this field entirely
|
|
2743
|
+
* to keep them unchanged.
|
|
2744
|
+
*/
|
|
2745
|
+
lineGroups?: Array<SalesReceiptUpdateParams.LineGroup>;
|
|
2746
|
+
/**
|
|
2747
|
+
* Body param: The sales receipt's line items, each representing a single product
|
|
2748
|
+
* or service sold.
|
|
2749
|
+
*
|
|
2750
|
+
* **IMPORTANT**:
|
|
2751
|
+
*
|
|
2752
|
+
* 1. Including this array in your update request will **REPLACE** all existing
|
|
2753
|
+
* line items for the sales receipt with this array. To keep any existing line
|
|
2754
|
+
* items, you must include them in this array even if they have not changed.
|
|
2755
|
+
* **Any line items not included will be removed.**
|
|
2756
|
+
*
|
|
2757
|
+
* 2. To add a new line item, include it here with the `id` field set to `-1`.
|
|
2758
|
+
*
|
|
2759
|
+
* 3. If you do not wish to modify any line items, omit this field entirely to keep
|
|
2760
|
+
* them unchanged.
|
|
2761
|
+
*/
|
|
2762
|
+
lines?: Array<SalesReceiptUpdateParams.Line>;
|
|
2763
|
+
/**
|
|
2764
|
+
* Body param: A memo or note for this sales receipt that appears in reports, but
|
|
2765
|
+
* not on the sales receipt.
|
|
2766
|
+
*/
|
|
2767
|
+
memo?: string;
|
|
2768
|
+
/**
|
|
2769
|
+
* Body param: A built-in custom field for additional information specific to this
|
|
2770
|
+
* sales receipt. Unlike the user-defined fields in the `customFields` array, this
|
|
2771
|
+
* is a standard QuickBooks field that exists for all sales receipts for
|
|
2772
|
+
* convenience. Developers often use this field for tracking information that
|
|
2773
|
+
* doesn't fit into other standard QuickBooks fields. Unlike `otherCustomField1`
|
|
2774
|
+
* and `otherCustomField2`, which are line item fields, this exists at the
|
|
2775
|
+
* transaction level. Hidden by default in the QuickBooks UI.
|
|
2776
|
+
*/
|
|
2777
|
+
otherCustomField?: string;
|
|
2778
|
+
/**
|
|
2779
|
+
* Body param: The sales receipt's payment method (e.g., cash, check, credit card).
|
|
2780
|
+
*/
|
|
2781
|
+
paymentMethodId?: string;
|
|
2782
|
+
/**
|
|
2783
|
+
* Body param: The case-sensitive user-defined reference number for this sales
|
|
2784
|
+
* receipt, which can be used to identify the transaction in QuickBooks. This value
|
|
2785
|
+
* is not required to be unique and can be arbitrarily changed by the QuickBooks
|
|
2786
|
+
* user.
|
|
2787
|
+
*/
|
|
2788
|
+
refNumber?: string;
|
|
2789
|
+
/**
|
|
2790
|
+
* Body param: The sales receipt's sales representative. Sales representatives can
|
|
2791
|
+
* be employees, vendors, or other names in QuickBooks.
|
|
2792
|
+
*/
|
|
2793
|
+
salesRepresentativeId?: string;
|
|
2794
|
+
/**
|
|
2795
|
+
* Body param: The sales-tax code for this sales receipt, determining whether it is
|
|
2796
|
+
* taxable or non-taxable. This can be overridden at the transaction-line level.
|
|
2797
|
+
*
|
|
2798
|
+
* Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
|
|
2799
|
+
* can also be created in QuickBooks. If QuickBooks is not set up to charge sales
|
|
2800
|
+
* tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
|
|
2801
|
+
* non-taxable code to all sales.
|
|
2802
|
+
*/
|
|
2803
|
+
salesTaxCodeId?: string;
|
|
2804
|
+
/**
|
|
2805
|
+
* Body param: The sales-tax item used to calculate the actual tax amount for this
|
|
2806
|
+
* sales receipt's transactions by applying a specific tax rate collected for a
|
|
2807
|
+
* single tax agency. Unlike `salesTaxCode`, which only indicates general
|
|
2808
|
+
* taxability, this field drives the actual tax calculation and reporting.
|
|
2809
|
+
*
|
|
2810
|
+
* For sales receipts, while using this field to specify a single tax item/group
|
|
2811
|
+
* that applies uniformly is recommended, complex tax scenarios may require
|
|
2812
|
+
* alternative approaches. In such cases, you can set this field to a 0% tax item
|
|
2813
|
+
* (conventionally named "Tax Calculated On Invoice") and handle tax calculations
|
|
2814
|
+
* through line items instead. When using line items for taxes, note that only
|
|
2815
|
+
* individual tax items (not tax groups) can be used, subtotals can help apply a
|
|
2816
|
+
* tax to multiple items but only the first tax line after a subtotal is calculated
|
|
2817
|
+
* automatically (subsequent tax lines require manual amounts), and the rate column
|
|
2818
|
+
* will always display the actual tax amount rather than the rate percentage.
|
|
2819
|
+
*/
|
|
2820
|
+
salesTaxItemId?: string;
|
|
2821
|
+
/**
|
|
2822
|
+
* Body param: The origin location from where the product associated with this
|
|
2823
|
+
* sales receipt is shipped. This is the point at which ownership and liability for
|
|
2824
|
+
* goods transfer from seller to buyer. Internally, QuickBooks uses the term "FOB"
|
|
2825
|
+
* for this field, which stands for "freight on board". This field is informational
|
|
2826
|
+
* and has no accounting implications.
|
|
2827
|
+
*/
|
|
2828
|
+
shipmentOrigin?: string;
|
|
2829
|
+
/**
|
|
2830
|
+
* Body param: The sales receipt's shipping address.
|
|
2831
|
+
*/
|
|
2832
|
+
shippingAddress?: SalesReceiptUpdateParams.ShippingAddress;
|
|
2833
|
+
/**
|
|
2834
|
+
* Body param: The date when the products or services for this sales receipt were
|
|
2835
|
+
* shipped or are expected to be shipped, in ISO 8601 format (YYYY-MM-DD).
|
|
2836
|
+
*/
|
|
2837
|
+
shippingDate?: string;
|
|
2838
|
+
/**
|
|
2839
|
+
* Body param: The shipping method used for this sales receipt, such as standard
|
|
2840
|
+
* mail or overnight delivery.
|
|
2841
|
+
*/
|
|
2842
|
+
shippingMethodId?: string;
|
|
2843
|
+
/**
|
|
2844
|
+
* Body param: The date of this sales receipt, in ISO 8601 format (YYYY-MM-DD).
|
|
2845
|
+
*/
|
|
2846
|
+
transactionDate?: string;
|
|
2847
|
+
}
|
|
2848
|
+
export declare namespace SalesReceiptUpdateParams {
|
|
2849
|
+
/**
|
|
2850
|
+
* The sales receipt's billing address.
|
|
2851
|
+
*/
|
|
2852
|
+
interface BillingAddress {
|
|
2853
|
+
/**
|
|
2854
|
+
* The city, district, suburb, town, or village name of the address.
|
|
2855
|
+
*
|
|
2856
|
+
* Maximum length: 31 characters.
|
|
2857
|
+
*/
|
|
2858
|
+
city?: string;
|
|
2859
|
+
/**
|
|
2860
|
+
* The country name of the address.
|
|
2861
|
+
*/
|
|
2862
|
+
country?: string;
|
|
2863
|
+
/**
|
|
2864
|
+
* The first line of the address (e.g., street, PO Box, or company name).
|
|
2865
|
+
*
|
|
2866
|
+
* Maximum length: 41 characters.
|
|
2867
|
+
*/
|
|
2868
|
+
line1?: string;
|
|
2869
|
+
/**
|
|
2870
|
+
* The second line of the address, if needed (e.g., apartment, suite, unit, or
|
|
2871
|
+
* building).
|
|
2872
|
+
*
|
|
2873
|
+
* Maximum length: 41 characters.
|
|
2874
|
+
*/
|
|
2875
|
+
line2?: string;
|
|
2876
|
+
/**
|
|
2877
|
+
* The third line of the address, if needed.
|
|
2878
|
+
*
|
|
2879
|
+
* Maximum length: 41 characters.
|
|
2880
|
+
*/
|
|
2881
|
+
line3?: string;
|
|
2882
|
+
/**
|
|
2883
|
+
* The fourth line of the address, if needed.
|
|
2884
|
+
*
|
|
2885
|
+
* Maximum length: 41 characters.
|
|
2886
|
+
*/
|
|
2887
|
+
line4?: string;
|
|
2888
|
+
/**
|
|
2889
|
+
* The fifth line of the address, if needed.
|
|
2890
|
+
*
|
|
2891
|
+
* Maximum length: 41 characters.
|
|
2892
|
+
*/
|
|
2893
|
+
line5?: string;
|
|
2894
|
+
/**
|
|
2895
|
+
* A note written at the bottom of the address in the form in which it appears,
|
|
2896
|
+
* such as the invoice form.
|
|
2897
|
+
*/
|
|
2898
|
+
note?: string;
|
|
2899
|
+
/**
|
|
2900
|
+
* The postal code or ZIP code of the address.
|
|
2901
|
+
*
|
|
2902
|
+
* Maximum length: 13 characters.
|
|
2903
|
+
*/
|
|
2904
|
+
postalCode?: string;
|
|
2905
|
+
/**
|
|
2906
|
+
* The state, county, province, or region name of the address.
|
|
2907
|
+
*
|
|
2908
|
+
* Maximum length: 21 characters.
|
|
2909
|
+
*/
|
|
2910
|
+
state?: string;
|
|
2911
|
+
}
|
|
2912
|
+
interface LineGroup {
|
|
2913
|
+
/**
|
|
2914
|
+
* The QuickBooks-assigned unique identifier of an existing sales receipt line
|
|
2915
|
+
* group you wish to retain or update.
|
|
2916
|
+
*
|
|
2917
|
+
* **IMPORTANT**: Set this field to `-1` for new sales receipt line groups you wish
|
|
2918
|
+
* to add.
|
|
2919
|
+
*/
|
|
2920
|
+
id: string;
|
|
2921
|
+
/**
|
|
2922
|
+
* The sales receipt line group's item group, representing a predefined set of
|
|
2923
|
+
* items bundled because they are commonly purchased together or grouped for faster
|
|
2924
|
+
* entry.
|
|
2925
|
+
*/
|
|
2926
|
+
itemGroupId?: string;
|
|
2927
|
+
/**
|
|
2928
|
+
* The sales receipt line group's line items, each representing a single product or
|
|
2929
|
+
* service sold.
|
|
2930
|
+
*
|
|
2931
|
+
* **IMPORTANT**:
|
|
2932
|
+
*
|
|
2933
|
+
* 1. Including this array in your update request will **REPLACE** all existing
|
|
2934
|
+
* line items for the sales receipt line group with this array. To keep any
|
|
2935
|
+
* existing line items, you must include them in this array even if they have
|
|
2936
|
+
* not changed. **Any line items not included will be removed.**
|
|
2937
|
+
*
|
|
2938
|
+
* 2. To add a new line item, include it here with the `id` field set to `-1`.
|
|
2939
|
+
*
|
|
2940
|
+
* 3. If you do not wish to modify any line items, omit this field entirely to keep
|
|
2941
|
+
* them unchanged.
|
|
2942
|
+
*/
|
|
2943
|
+
lines?: Array<LineGroup.Line>;
|
|
2944
|
+
/**
|
|
2945
|
+
* Specifies an alternative unit-of-measure set when updating this sales receipt
|
|
2946
|
+
* line group's `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows
|
|
2947
|
+
* you to select units from a different set than the item's default unit-of-measure
|
|
2948
|
+
* set, which remains unchanged on the item itself. The override applies only to
|
|
2949
|
+
* this specific line. For example, you can sell an item typically measured in
|
|
2950
|
+
* volume units using weight units in a specific transaction by specifying a
|
|
2951
|
+
* different unit-of-measure set with this field.
|
|
2952
|
+
*/
|
|
2953
|
+
overrideUnitOfMeasureSetId?: string;
|
|
2954
|
+
/**
|
|
2955
|
+
* The quantity of the item group associated with this sales receipt line group.
|
|
2956
|
+
* This field cannot be cleared.
|
|
2957
|
+
*
|
|
2958
|
+
* **NOTE**: Do not use this field if the associated item group is a discount item
|
|
2959
|
+
* group.
|
|
2960
|
+
*/
|
|
2961
|
+
quantity?: number;
|
|
2962
|
+
/**
|
|
2963
|
+
* The unit-of-measure used for the `quantity` in this sales receipt line group.
|
|
2964
|
+
* Must be a valid unit within the item's available units of measure.
|
|
2965
|
+
*/
|
|
2966
|
+
unitOfMeasure?: string;
|
|
2967
|
+
}
|
|
2968
|
+
namespace LineGroup {
|
|
2969
|
+
interface Line {
|
|
2970
|
+
/**
|
|
2971
|
+
* The QuickBooks-assigned unique identifier of an existing sales receipt line you
|
|
2972
|
+
* wish to retain or update.
|
|
2973
|
+
*
|
|
2974
|
+
* **IMPORTANT**: Set this field to `-1` for new sales receipt lines you wish to
|
|
2975
|
+
* add.
|
|
2976
|
+
*/
|
|
2977
|
+
id: string;
|
|
2978
|
+
/**
|
|
2979
|
+
* The monetary amount of this sales receipt line, represented as a decimal string.
|
|
2980
|
+
* If both `quantity` and `rate` are specified but not `amount`, QuickBooks will
|
|
2981
|
+
* use them to calculate `amount`. If `amount`, `rate`, and `quantity` are all
|
|
2982
|
+
* unspecified, then QuickBooks will calculate `amount` based on a `quantity` of
|
|
2983
|
+
* `1` and the suggested `rate`. This field cannot be cleared.
|
|
2984
|
+
*/
|
|
2985
|
+
amount?: string;
|
|
2986
|
+
/**
|
|
2987
|
+
* The sales receipt line's class. Classes can be used to categorize objects into
|
|
2988
|
+
* meaningful segments, such as department, location, or type of work. In
|
|
2989
|
+
* QuickBooks, class tracking is off by default. If a class is specified for the
|
|
2990
|
+
* entire parent transaction, it is automatically applied to all sales receipt
|
|
2991
|
+
* lines unless overridden here, at the transaction line level.
|
|
2992
|
+
*/
|
|
2993
|
+
classId?: string;
|
|
2994
|
+
/**
|
|
2995
|
+
* A description of this sales receipt line.
|
|
2996
|
+
*/
|
|
2997
|
+
description?: string;
|
|
2998
|
+
/**
|
|
2999
|
+
* The site location where inventory for the item associated with this sales
|
|
3000
|
+
* receipt line is stored.
|
|
3001
|
+
*/
|
|
3002
|
+
inventorySiteId?: string;
|
|
3003
|
+
/**
|
|
3004
|
+
* The specific location (e.g., bin or shelf) within the inventory site where the
|
|
3005
|
+
* item associated with this sales receipt line is stored.
|
|
3006
|
+
*/
|
|
3007
|
+
inventorySiteLocationId?: string;
|
|
3008
|
+
/**
|
|
3009
|
+
* The item associated with this sales receipt line. This can refer to any good or
|
|
3010
|
+
* service that the business buys or sells, including item types such as a service
|
|
3011
|
+
* item, inventory item, or special calculation item like a discount item or
|
|
3012
|
+
* sales-tax item.
|
|
3013
|
+
*/
|
|
3014
|
+
itemId?: string;
|
|
3015
|
+
/**
|
|
3016
|
+
* The lot number of the item associated with this sales receipt line. Used for
|
|
3017
|
+
* tracking groups of inventory items that are purchased or manufactured together.
|
|
3018
|
+
*/
|
|
3019
|
+
lotNumber?: string;
|
|
3020
|
+
/**
|
|
3021
|
+
* A built-in custom field for additional information specific to this sales
|
|
3022
|
+
* receipt line. Unlike the user-defined fields in the `customFields` array, this
|
|
3023
|
+
* is a standard QuickBooks field that exists for all sales receipt lines for
|
|
3024
|
+
* convenience. Developers often use this field for tracking information that
|
|
3025
|
+
* doesn't fit into other standard QuickBooks fields. Hidden by default in the
|
|
3026
|
+
* QuickBooks UI.
|
|
3027
|
+
*/
|
|
3028
|
+
otherCustomField1?: string;
|
|
3029
|
+
/**
|
|
3030
|
+
* A second built-in custom field for additional information specific to this sales
|
|
3031
|
+
* receipt line. Unlike the user-defined fields in the `customFields` array, this
|
|
3032
|
+
* is a standard QuickBooks field that exists for all sales receipt lines for
|
|
3033
|
+
* convenience. Like `otherCustomField1`, developers often use this field for
|
|
3034
|
+
* tracking information that doesn't fit into other standard QuickBooks fields.
|
|
3035
|
+
* Hidden by default in the QuickBooks UI.
|
|
3036
|
+
*/
|
|
3037
|
+
otherCustomField2?: string;
|
|
3038
|
+
/**
|
|
3039
|
+
* The account to use for this sales receipt line, overriding the default account
|
|
3040
|
+
* associated with the item.
|
|
3041
|
+
*/
|
|
3042
|
+
overrideItemAccountId?: string;
|
|
3043
|
+
/**
|
|
3044
|
+
* Specifies an alternative unit-of-measure set when updating this sales receipt
|
|
3045
|
+
* line's `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to
|
|
3046
|
+
* select units from a different set than the item's default unit-of-measure set,
|
|
3047
|
+
* which remains unchanged on the item itself. The override applies only to this
|
|
3048
|
+
* specific line. For example, you can sell an item typically measured in volume
|
|
3049
|
+
* units using weight units in a specific transaction by specifying a different
|
|
3050
|
+
* unit-of-measure set with this field.
|
|
3051
|
+
*/
|
|
3052
|
+
overrideUnitOfMeasureSetId?: string;
|
|
3053
|
+
/**
|
|
3054
|
+
* The price level applied to this sales receipt line. This overrides any price
|
|
3055
|
+
* level set on the corresponding customer. The resulting sales receipt line will
|
|
3056
|
+
* not show this price level, only the final `rate` calculated from it.
|
|
3057
|
+
*/
|
|
3058
|
+
priceLevelId?: string;
|
|
3059
|
+
/**
|
|
3060
|
+
* Specifies how to resolve price rule conflicts when adding or modifying this
|
|
3061
|
+
* sales receipt line.
|
|
3062
|
+
*/
|
|
3063
|
+
priceRuleConflictStrategy?: 'base_price' | 'zero';
|
|
3064
|
+
/**
|
|
3065
|
+
* The quantity of the item associated with this sales receipt line. This field
|
|
3066
|
+
* cannot be cleared.
|
|
3067
|
+
*
|
|
3068
|
+
* **NOTE**: Do not use this field if the associated item is a discount item.
|
|
3069
|
+
*/
|
|
3070
|
+
quantity?: number;
|
|
3071
|
+
/**
|
|
3072
|
+
* The price per unit for this sales receipt line. If both `rate` and `amount` are
|
|
3073
|
+
* specified, `rate` will be ignored. If both `quantity` and `amount` are specified
|
|
3074
|
+
* but not `rate`, QuickBooks will use them to calculate `rate`. Represented as a
|
|
3075
|
+
* decimal string. This field cannot be cleared.
|
|
3076
|
+
*/
|
|
3077
|
+
rate?: string;
|
|
3078
|
+
/**
|
|
3079
|
+
* The price of this sales receipt line expressed as a percentage. Typically used
|
|
3080
|
+
* for discount or markup items.
|
|
3081
|
+
*/
|
|
3082
|
+
ratePercent?: string;
|
|
3083
|
+
/**
|
|
3084
|
+
* The sales-tax code for this sales receipt line, determining whether it is
|
|
3085
|
+
* taxable or non-taxable. If set, this overrides any sales-tax codes defined on
|
|
3086
|
+
* the parent transaction or the associated item.
|
|
3087
|
+
*
|
|
3088
|
+
* Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
|
|
3089
|
+
* can also be created in QuickBooks. If QuickBooks is not set up to charge sales
|
|
3090
|
+
* tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
|
|
3091
|
+
* non-taxable code to all sales.
|
|
3092
|
+
*/
|
|
3093
|
+
salesTaxCodeId?: string;
|
|
3094
|
+
/**
|
|
3095
|
+
* The serial number of the item associated with this sales receipt line. This is
|
|
3096
|
+
* used for tracking individual units of serialized inventory items.
|
|
3097
|
+
*/
|
|
3098
|
+
serialNumber?: string;
|
|
3099
|
+
/**
|
|
3100
|
+
* The date on which the service for this sales receipt line was or will be
|
|
3101
|
+
* performed, in ISO 8601 format (YYYY-MM-DD). This is particularly relevant for
|
|
3102
|
+
* service items.
|
|
3103
|
+
*/
|
|
3104
|
+
serviceDate?: string;
|
|
3105
|
+
/**
|
|
3106
|
+
* The unit-of-measure used for the `quantity` in this sales receipt line. Must be
|
|
3107
|
+
* a valid unit within the item's available units of measure.
|
|
3108
|
+
*/
|
|
3109
|
+
unitOfMeasure?: string;
|
|
3110
|
+
}
|
|
3111
|
+
}
|
|
3112
|
+
interface Line {
|
|
3113
|
+
/**
|
|
3114
|
+
* The QuickBooks-assigned unique identifier of an existing sales receipt line you
|
|
3115
|
+
* wish to retain or update.
|
|
3116
|
+
*
|
|
3117
|
+
* **IMPORTANT**: Set this field to `-1` for new sales receipt lines you wish to
|
|
3118
|
+
* add.
|
|
3119
|
+
*/
|
|
3120
|
+
id: string;
|
|
3121
|
+
/**
|
|
3122
|
+
* The monetary amount of this sales receipt line, represented as a decimal string.
|
|
3123
|
+
* If both `quantity` and `rate` are specified but not `amount`, QuickBooks will
|
|
3124
|
+
* use them to calculate `amount`. If `amount`, `rate`, and `quantity` are all
|
|
3125
|
+
* unspecified, then QuickBooks will calculate `amount` based on a `quantity` of
|
|
3126
|
+
* `1` and the suggested `rate`. This field cannot be cleared.
|
|
3127
|
+
*/
|
|
3128
|
+
amount?: string;
|
|
3129
|
+
/**
|
|
3130
|
+
* The sales receipt line's class. Classes can be used to categorize objects into
|
|
3131
|
+
* meaningful segments, such as department, location, or type of work. In
|
|
3132
|
+
* QuickBooks, class tracking is off by default. If a class is specified for the
|
|
3133
|
+
* entire parent transaction, it is automatically applied to all sales receipt
|
|
3134
|
+
* lines unless overridden here, at the transaction line level.
|
|
3135
|
+
*/
|
|
3136
|
+
classId?: string;
|
|
3137
|
+
/**
|
|
3138
|
+
* A description of this sales receipt line.
|
|
3139
|
+
*/
|
|
3140
|
+
description?: string;
|
|
3141
|
+
/**
|
|
3142
|
+
* The site location where inventory for the item associated with this sales
|
|
3143
|
+
* receipt line is stored.
|
|
3144
|
+
*/
|
|
3145
|
+
inventorySiteId?: string;
|
|
3146
|
+
/**
|
|
3147
|
+
* The specific location (e.g., bin or shelf) within the inventory site where the
|
|
3148
|
+
* item associated with this sales receipt line is stored.
|
|
3149
|
+
*/
|
|
3150
|
+
inventorySiteLocationId?: string;
|
|
3151
|
+
/**
|
|
3152
|
+
* The item associated with this sales receipt line. This can refer to any good or
|
|
3153
|
+
* service that the business buys or sells, including item types such as a service
|
|
3154
|
+
* item, inventory item, or special calculation item like a discount item or
|
|
3155
|
+
* sales-tax item.
|
|
3156
|
+
*/
|
|
3157
|
+
itemId?: string;
|
|
3158
|
+
/**
|
|
3159
|
+
* The lot number of the item associated with this sales receipt line. Used for
|
|
3160
|
+
* tracking groups of inventory items that are purchased or manufactured together.
|
|
3161
|
+
*/
|
|
3162
|
+
lotNumber?: string;
|
|
3163
|
+
/**
|
|
3164
|
+
* A built-in custom field for additional information specific to this sales
|
|
3165
|
+
* receipt line. Unlike the user-defined fields in the `customFields` array, this
|
|
3166
|
+
* is a standard QuickBooks field that exists for all sales receipt lines for
|
|
3167
|
+
* convenience. Developers often use this field for tracking information that
|
|
3168
|
+
* doesn't fit into other standard QuickBooks fields. Hidden by default in the
|
|
3169
|
+
* QuickBooks UI.
|
|
3170
|
+
*/
|
|
3171
|
+
otherCustomField1?: string;
|
|
3172
|
+
/**
|
|
3173
|
+
* A second built-in custom field for additional information specific to this sales
|
|
3174
|
+
* receipt line. Unlike the user-defined fields in the `customFields` array, this
|
|
3175
|
+
* is a standard QuickBooks field that exists for all sales receipt lines for
|
|
3176
|
+
* convenience. Like `otherCustomField1`, developers often use this field for
|
|
3177
|
+
* tracking information that doesn't fit into other standard QuickBooks fields.
|
|
3178
|
+
* Hidden by default in the QuickBooks UI.
|
|
3179
|
+
*/
|
|
3180
|
+
otherCustomField2?: string;
|
|
3181
|
+
/**
|
|
3182
|
+
* The account to use for this sales receipt line, overriding the default account
|
|
3183
|
+
* associated with the item.
|
|
3184
|
+
*/
|
|
3185
|
+
overrideItemAccountId?: string;
|
|
3186
|
+
/**
|
|
3187
|
+
* Specifies an alternative unit-of-measure set when updating this sales receipt
|
|
3188
|
+
* line's `unitOfMeasure` field (e.g., "pound" or "kilogram"). This allows you to
|
|
3189
|
+
* select units from a different set than the item's default unit-of-measure set,
|
|
3190
|
+
* which remains unchanged on the item itself. The override applies only to this
|
|
3191
|
+
* specific line. For example, you can sell an item typically measured in volume
|
|
3192
|
+
* units using weight units in a specific transaction by specifying a different
|
|
3193
|
+
* unit-of-measure set with this field.
|
|
3194
|
+
*/
|
|
3195
|
+
overrideUnitOfMeasureSetId?: string;
|
|
3196
|
+
/**
|
|
3197
|
+
* The price level applied to this sales receipt line. This overrides any price
|
|
3198
|
+
* level set on the corresponding customer. The resulting sales receipt line will
|
|
3199
|
+
* not show this price level, only the final `rate` calculated from it.
|
|
3200
|
+
*/
|
|
3201
|
+
priceLevelId?: string;
|
|
3202
|
+
/**
|
|
3203
|
+
* Specifies how to resolve price rule conflicts when adding or modifying this
|
|
3204
|
+
* sales receipt line.
|
|
3205
|
+
*/
|
|
3206
|
+
priceRuleConflictStrategy?: 'base_price' | 'zero';
|
|
3207
|
+
/**
|
|
3208
|
+
* The quantity of the item associated with this sales receipt line. This field
|
|
3209
|
+
* cannot be cleared.
|
|
3210
|
+
*
|
|
3211
|
+
* **NOTE**: Do not use this field if the associated item is a discount item.
|
|
3212
|
+
*/
|
|
3213
|
+
quantity?: number;
|
|
3214
|
+
/**
|
|
3215
|
+
* The price per unit for this sales receipt line. If both `rate` and `amount` are
|
|
3216
|
+
* specified, `rate` will be ignored. If both `quantity` and `amount` are specified
|
|
3217
|
+
* but not `rate`, QuickBooks will use them to calculate `rate`. Represented as a
|
|
3218
|
+
* decimal string. This field cannot be cleared.
|
|
3219
|
+
*/
|
|
3220
|
+
rate?: string;
|
|
3221
|
+
/**
|
|
3222
|
+
* The price of this sales receipt line expressed as a percentage. Typically used
|
|
3223
|
+
* for discount or markup items.
|
|
3224
|
+
*/
|
|
3225
|
+
ratePercent?: string;
|
|
3226
|
+
/**
|
|
3227
|
+
* The sales-tax code for this sales receipt line, determining whether it is
|
|
3228
|
+
* taxable or non-taxable. If set, this overrides any sales-tax codes defined on
|
|
3229
|
+
* the parent transaction or the associated item.
|
|
3230
|
+
*
|
|
3231
|
+
* Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes
|
|
3232
|
+
* can also be created in QuickBooks. If QuickBooks is not set up to charge sales
|
|
3233
|
+
* tax (via the "Do You Charge Sales Tax?" preference), it will assign the default
|
|
3234
|
+
* non-taxable code to all sales.
|
|
3235
|
+
*/
|
|
3236
|
+
salesTaxCodeId?: string;
|
|
3237
|
+
/**
|
|
3238
|
+
* The serial number of the item associated with this sales receipt line. This is
|
|
3239
|
+
* used for tracking individual units of serialized inventory items.
|
|
3240
|
+
*/
|
|
3241
|
+
serialNumber?: string;
|
|
3242
|
+
/**
|
|
3243
|
+
* The date on which the service for this sales receipt line was or will be
|
|
3244
|
+
* performed, in ISO 8601 format (YYYY-MM-DD). This is particularly relevant for
|
|
3245
|
+
* service items.
|
|
3246
|
+
*/
|
|
3247
|
+
serviceDate?: string;
|
|
3248
|
+
/**
|
|
3249
|
+
* The unit-of-measure used for the `quantity` in this sales receipt line. Must be
|
|
3250
|
+
* a valid unit within the item's available units of measure.
|
|
3251
|
+
*/
|
|
3252
|
+
unitOfMeasure?: string;
|
|
3253
|
+
}
|
|
3254
|
+
/**
|
|
3255
|
+
* The sales receipt's shipping address.
|
|
3256
|
+
*/
|
|
3257
|
+
interface ShippingAddress {
|
|
3258
|
+
/**
|
|
3259
|
+
* The city, district, suburb, town, or village name of the address.
|
|
3260
|
+
*
|
|
3261
|
+
* Maximum length: 31 characters.
|
|
3262
|
+
*/
|
|
3263
|
+
city?: string;
|
|
3264
|
+
/**
|
|
3265
|
+
* The country name of the address.
|
|
3266
|
+
*/
|
|
3267
|
+
country?: string;
|
|
3268
|
+
/**
|
|
3269
|
+
* The first line of the address (e.g., street, PO Box, or company name).
|
|
3270
|
+
*
|
|
3271
|
+
* Maximum length: 41 characters.
|
|
3272
|
+
*/
|
|
3273
|
+
line1?: string;
|
|
3274
|
+
/**
|
|
3275
|
+
* The second line of the address, if needed (e.g., apartment, suite, unit, or
|
|
3276
|
+
* building).
|
|
3277
|
+
*
|
|
3278
|
+
* Maximum length: 41 characters.
|
|
3279
|
+
*/
|
|
3280
|
+
line2?: string;
|
|
3281
|
+
/**
|
|
3282
|
+
* The third line of the address, if needed.
|
|
3283
|
+
*
|
|
3284
|
+
* Maximum length: 41 characters.
|
|
3285
|
+
*/
|
|
3286
|
+
line3?: string;
|
|
3287
|
+
/**
|
|
3288
|
+
* The fourth line of the address, if needed.
|
|
3289
|
+
*
|
|
3290
|
+
* Maximum length: 41 characters.
|
|
3291
|
+
*/
|
|
3292
|
+
line4?: string;
|
|
3293
|
+
/**
|
|
3294
|
+
* The fifth line of the address, if needed.
|
|
3295
|
+
*
|
|
3296
|
+
* Maximum length: 41 characters.
|
|
3297
|
+
*/
|
|
3298
|
+
line5?: string;
|
|
3299
|
+
/**
|
|
3300
|
+
* A note written at the bottom of the address in the form in which it appears,
|
|
3301
|
+
* such as the invoice form.
|
|
3302
|
+
*/
|
|
3303
|
+
note?: string;
|
|
3304
|
+
/**
|
|
3305
|
+
* The postal code or ZIP code of the address.
|
|
3306
|
+
*
|
|
3307
|
+
* Maximum length: 13 characters.
|
|
3308
|
+
*/
|
|
3309
|
+
postalCode?: string;
|
|
3310
|
+
/**
|
|
3311
|
+
* The state, county, province, or region name of the address.
|
|
3312
|
+
*
|
|
3313
|
+
* Maximum length: 21 characters.
|
|
3314
|
+
*/
|
|
3315
|
+
state?: string;
|
|
3316
|
+
}
|
|
3317
|
+
}
|
|
3318
|
+
export interface SalesReceiptListParams extends CursorPageParams {
|
|
3319
|
+
/**
|
|
3320
|
+
* Header param: The ID of the End-User to receive this request.
|
|
3321
|
+
*/
|
|
3322
|
+
conductorEndUserId: string;
|
|
3323
|
+
/**
|
|
3324
|
+
* Query param: Filter for sales receipts associated with these accounts.
|
|
3325
|
+
*/
|
|
3326
|
+
accountIds?: Array<string>;
|
|
3327
|
+
/**
|
|
3328
|
+
* Query param: Filter for sales receipts in these currencies.
|
|
3329
|
+
*/
|
|
3330
|
+
currencyIds?: Array<string>;
|
|
3331
|
+
/**
|
|
3332
|
+
* Query param: Filter for sales receipts created for these customers.
|
|
3333
|
+
*/
|
|
3334
|
+
customerIds?: Array<string>;
|
|
3335
|
+
/**
|
|
3336
|
+
* Query param: Filter for specific sales receipts by their QuickBooks-assigned
|
|
3337
|
+
* unique identifier(s).
|
|
3338
|
+
*
|
|
3339
|
+
* **IMPORTANT**: If you include this parameter, QuickBooks will ignore all other
|
|
3340
|
+
* query parameters for this request.
|
|
3341
|
+
*
|
|
3342
|
+
* **NOTE**: If any of the values you specify in this parameter are not found, the
|
|
3343
|
+
* request will return an error.
|
|
3344
|
+
*/
|
|
3345
|
+
ids?: Array<string>;
|
|
3346
|
+
/**
|
|
3347
|
+
* Query param: Whether to include line items in the response. Defaults to `true`.
|
|
3348
|
+
*/
|
|
3349
|
+
includeLineItems?: boolean;
|
|
3350
|
+
/**
|
|
3351
|
+
* Query param: Filter for sales receipts whose `refNumber` contains this
|
|
3352
|
+
* substring.
|
|
3353
|
+
*
|
|
3354
|
+
* **NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith`
|
|
3355
|
+
* or `refNumberEndsWith`.
|
|
3356
|
+
*/
|
|
3357
|
+
refNumberContains?: string;
|
|
3358
|
+
/**
|
|
3359
|
+
* Query param: Filter for sales receipts whose `refNumber` ends with this
|
|
3360
|
+
* substring.
|
|
3361
|
+
*
|
|
3362
|
+
* **NOTE**: If you use this parameter, you cannot also use `refNumberContains` or
|
|
3363
|
+
* `refNumberStartsWith`.
|
|
3364
|
+
*/
|
|
3365
|
+
refNumberEndsWith?: string;
|
|
3366
|
+
/**
|
|
3367
|
+
* Query param: Filter for sales receipts whose `refNumber` is greater than or
|
|
3368
|
+
* equal to this value. If omitted, the range will begin with the first number of
|
|
3369
|
+
* the list. Uses a numerical comparison for values that contain only digits;
|
|
3370
|
+
* otherwise, uses a lexicographical comparison.
|
|
3371
|
+
*/
|
|
3372
|
+
refNumberFrom?: string;
|
|
3373
|
+
/**
|
|
3374
|
+
* Query param: Filter for specific sales receipts by their ref-number(s),
|
|
3375
|
+
* case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can
|
|
3376
|
+
* be arbitrarily changed by the QuickBooks user.
|
|
3377
|
+
*
|
|
3378
|
+
* **IMPORTANT**: If you include this parameter, QuickBooks will ignore all other
|
|
3379
|
+
* query parameters for this request.
|
|
3380
|
+
*
|
|
3381
|
+
* **NOTE**: If any of the values you specify in this parameter are not found, the
|
|
3382
|
+
* request will return an error.
|
|
3383
|
+
*/
|
|
3384
|
+
refNumbers?: Array<string>;
|
|
3385
|
+
/**
|
|
3386
|
+
* Query param: Filter for sales receipts whose `refNumber` starts with this
|
|
3387
|
+
* substring.
|
|
3388
|
+
*
|
|
3389
|
+
* **NOTE**: If you use this parameter, you cannot also use `refNumberContains` or
|
|
3390
|
+
* `refNumberEndsWith`.
|
|
3391
|
+
*/
|
|
3392
|
+
refNumberStartsWith?: string;
|
|
3393
|
+
/**
|
|
3394
|
+
* Query param: Filter for sales receipts whose `refNumber` is less than or equal
|
|
3395
|
+
* to this value. If omitted, the range will end with the last number of the list.
|
|
3396
|
+
* Uses a numerical comparison for values that contain only digits; otherwise, uses
|
|
3397
|
+
* a lexicographical comparison.
|
|
3398
|
+
*/
|
|
3399
|
+
refNumberTo?: string;
|
|
3400
|
+
/**
|
|
3401
|
+
* Query param: Filter for sales receipts whose `date` field is on or after this
|
|
3402
|
+
* date, in ISO 8601 format (YYYY-MM-DD).
|
|
3403
|
+
*
|
|
3404
|
+
* **NOTE:** QuickBooks Desktop interprets this date as the **start of the
|
|
3405
|
+
* specified day** in the local timezone of the end-user's computer (e.g.,
|
|
3406
|
+
* `2025-01-01` → `2025-01-01T00:00:00`).
|
|
3407
|
+
*/
|
|
3408
|
+
transactionDateFrom?: string;
|
|
3409
|
+
/**
|
|
3410
|
+
* Query param: Filter for sales receipts whose `date` field is on or before this
|
|
3411
|
+
* date, in ISO 8601 format (YYYY-MM-DD).
|
|
3412
|
+
*
|
|
3413
|
+
* **NOTE:** QuickBooks Desktop interprets this date as the **end of the specified
|
|
3414
|
+
* day** in the local timezone of the end-user's computer (e.g., `2025-01-01` →
|
|
3415
|
+
* `2025-01-01T23:59:59`).
|
|
3416
|
+
*/
|
|
3417
|
+
transactionDateTo?: string;
|
|
3418
|
+
/**
|
|
3419
|
+
* Query param: Filter for sales receipts updated on or after this date/time.
|
|
3420
|
+
* Accepts the following ISO 8601 formats:
|
|
3421
|
+
*
|
|
3422
|
+
* - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the
|
|
3423
|
+
* **start of the specified day** in the local timezone of the end-user's
|
|
3424
|
+
* computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`).
|
|
3425
|
+
* - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop
|
|
3426
|
+
* interprets the timestamp in the local timezone of the end-user's computer.
|
|
3427
|
+
* - **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop
|
|
3428
|
+
* interprets the timestamp using the specified timezone.
|
|
3429
|
+
*/
|
|
3430
|
+
updatedAfter?: string;
|
|
3431
|
+
/**
|
|
3432
|
+
* Query param: Filter for sales receipts updated on or before this date/time.
|
|
3433
|
+
* Accepts the following ISO 8601 formats:
|
|
3434
|
+
*
|
|
3435
|
+
* - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the
|
|
3436
|
+
* **end of the specified day** in the local timezone of the end-user's computer
|
|
3437
|
+
* (e.g., `2025-01-01` → `2025-01-01T23:59:59`).
|
|
3438
|
+
* - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop
|
|
3439
|
+
* interprets the timestamp in the local timezone of the end-user's computer.
|
|
3440
|
+
* - **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop
|
|
3441
|
+
* interprets the timestamp using the specified timezone.
|
|
3442
|
+
*/
|
|
3443
|
+
updatedBefore?: string;
|
|
3444
|
+
}
|
|
3445
|
+
export interface SalesReceiptDeleteParams {
|
|
3446
|
+
/**
|
|
3447
|
+
* The ID of the End-User to receive this request.
|
|
3448
|
+
*/
|
|
3449
|
+
conductorEndUserId: string;
|
|
3450
|
+
}
|
|
3451
|
+
export declare namespace SalesReceipts {
|
|
3452
|
+
export { type SalesReceipt as SalesReceipt, type SalesReceiptDeleteResponse as SalesReceiptDeleteResponse, type SalesReceiptsCursorPage as SalesReceiptsCursorPage, type SalesReceiptCreateParams as SalesReceiptCreateParams, type SalesReceiptRetrieveParams as SalesReceiptRetrieveParams, type SalesReceiptUpdateParams as SalesReceiptUpdateParams, type SalesReceiptListParams as SalesReceiptListParams, type SalesReceiptDeleteParams as SalesReceiptDeleteParams, };
|
|
3453
|
+
}
|
|
3454
|
+
//# sourceMappingURL=sales-receipts.d.mts.map
|