@simpleapps-com/augur-api 2026.10.31 → 2026.11.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +84 -33
- package/SKILL.md +25 -24
- package/dist/client.d.ts +334 -0
- package/dist/client.d.ts.map +1 -0
- package/dist/core/base-client.d.ts +179 -0
- package/dist/core/base-client.d.ts.map +1 -0
- package/dist/core/call-rules.d.ts +73 -0
- package/dist/core/call-rules.d.ts.map +1 -0
- package/dist/core/call.d.ts +48 -0
- package/dist/core/call.d.ts.map +1 -0
- package/dist/core/client.d.ts +112 -0
- package/dist/core/client.d.ts.map +1 -0
- package/dist/core/common-schemas.d.ts +522 -0
- package/dist/core/common-schemas.d.ts.map +1 -0
- package/dist/core/config.d.ts +72 -0
- package/dist/core/config.d.ts.map +1 -0
- package/dist/core/encoded-segment.d.ts +23 -0
- package/dist/core/encoded-segment.d.ts.map +1 -0
- package/dist/core/errors.d.ts +91 -0
- package/dist/core/errors.d.ts.map +1 -0
- package/dist/core/http-rules.d.ts +64 -0
- package/dist/core/http-rules.d.ts.map +1 -0
- package/dist/core/path-validation.d.ts +28 -0
- package/dist/core/path-validation.d.ts.map +1 -0
- package/dist/core/proxy-rules.d.ts +21 -0
- package/dist/core/proxy-rules.d.ts.map +1 -0
- package/dist/core/registry-rules.d.ts +15 -0
- package/dist/core/registry-rules.d.ts.map +1 -0
- package/dist/core/registry-tables.d.ts +3 -0
- package/dist/core/registry-tables.d.ts.map +1 -0
- package/dist/core/registry.d.ts +54 -0
- package/dist/core/registry.d.ts.map +1 -0
- package/dist/core/response-rules.d.ts +19 -0
- package/dist/core/response-rules.d.ts.map +1 -0
- package/dist/core/schemas.d.ts +70 -0
- package/dist/core/schemas.d.ts.map +1 -0
- package/dist/core/service-proxy.d.ts +81 -0
- package/dist/core/service-proxy.d.ts.map +1 -0
- package/dist/core/site-id-check.d.ts +6 -0
- package/dist/core/site-id-check.d.ts.map +1 -0
- package/dist/core/site-id.d.ts +15 -0
- package/dist/core/site-id.d.ts.map +1 -0
- package/dist/index.d.ts +71 -236
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +19875 -18513
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +19874 -18513
- package/dist/index.mjs.map +1 -1
- package/dist/services/agr-info/client.d.ts +71 -0
- package/dist/services/agr-info/client.d.ts.map +1 -0
- package/dist/services/agr-info/generated/endpoints.d.ts +41 -0
- package/dist/services/agr-info/generated/endpoints.d.ts.map +1 -0
- package/dist/services/agr-info/generated/schemas.d.ts +297 -0
- package/dist/services/agr-info/generated/schemas.d.ts.map +1 -0
- package/dist/services/agr-info/generated/types.d.ts +1093 -0
- package/dist/services/agr-info/generated/types.d.ts.map +1 -0
- package/dist/services/agr-info/index.d.ts +2 -0
- package/dist/services/agr-info/index.d.ts.map +1 -0
- package/dist/services/agr-int/client.d.ts +100 -0
- package/dist/services/agr-int/client.d.ts.map +1 -0
- package/dist/services/agr-int/generated/endpoints.d.ts +42 -0
- package/dist/services/agr-int/generated/endpoints.d.ts.map +1 -0
- package/dist/services/agr-int/generated/schemas.d.ts +595 -0
- package/dist/services/agr-int/generated/schemas.d.ts.map +1 -0
- package/dist/services/agr-int/generated/types.d.ts +1984 -0
- package/dist/services/agr-int/generated/types.d.ts.map +1 -0
- package/dist/services/agr-int/index.d.ts +2 -0
- package/dist/services/agr-int/index.d.ts.map +1 -0
- package/dist/services/agr-site/client.d.ts +112 -0
- package/dist/services/agr-site/client.d.ts.map +1 -0
- package/dist/services/agr-site/generated/endpoints.d.ts +42 -0
- package/dist/services/agr-site/generated/endpoints.d.ts.map +1 -0
- package/dist/services/agr-site/generated/schemas.d.ts +537 -0
- package/dist/services/agr-site/generated/schemas.d.ts.map +1 -0
- package/dist/services/agr-site/generated/types.d.ts +1732 -0
- package/dist/services/agr-site/generated/types.d.ts.map +1 -0
- package/dist/services/agr-site/index.d.ts +2 -0
- package/dist/services/agr-site/index.d.ts.map +1 -0
- package/dist/services/agr-work/client.d.ts +23 -0
- package/dist/services/agr-work/client.d.ts.map +1 -0
- package/dist/services/agr-work/generated/endpoints.d.ts +41 -0
- package/dist/services/agr-work/generated/endpoints.d.ts.map +1 -0
- package/dist/services/agr-work/generated/schemas.d.ts +21 -0
- package/dist/services/agr-work/generated/schemas.d.ts.map +1 -0
- package/dist/services/agr-work/generated/types.d.ts +19 -0
- package/dist/services/agr-work/generated/types.d.ts.map +1 -0
- package/dist/services/agr-work/index.d.ts +2 -0
- package/dist/services/agr-work/index.d.ts.map +1 -0
- package/dist/services/avalara/client.d.ts +33 -0
- package/dist/services/avalara/client.d.ts.map +1 -0
- package/dist/services/avalara/generated/endpoints.d.ts +41 -0
- package/dist/services/avalara/generated/endpoints.d.ts.map +1 -0
- package/dist/services/avalara/generated/schemas.d.ts +22 -0
- package/dist/services/avalara/generated/schemas.d.ts.map +1 -0
- package/dist/services/avalara/generated/types.d.ts +103 -0
- package/dist/services/avalara/generated/types.d.ts.map +1 -0
- package/dist/services/avalara/index.d.ts +2 -0
- package/dist/services/avalara/index.d.ts.map +1 -0
- package/dist/services/basecamp2/client.d.ts +92 -0
- package/dist/services/basecamp2/client.d.ts.map +1 -0
- package/dist/services/basecamp2/generated/endpoints.d.ts +42 -0
- package/dist/services/basecamp2/generated/endpoints.d.ts.map +1 -0
- package/dist/services/basecamp2/generated/schemas.d.ts +845 -0
- package/dist/services/basecamp2/generated/schemas.d.ts.map +1 -0
- package/dist/services/basecamp2/generated/types.d.ts +1587 -0
- package/dist/services/basecamp2/generated/types.d.ts.map +1 -0
- package/dist/services/basecamp2/index.d.ts +2 -0
- package/dist/services/basecamp2/index.d.ts.map +1 -0
- package/dist/services/brand-folder/client.d.ts +37 -0
- package/dist/services/brand-folder/client.d.ts.map +1 -0
- package/dist/services/brand-folder/generated/endpoints.d.ts +41 -0
- package/dist/services/brand-folder/generated/endpoints.d.ts.map +1 -0
- package/dist/services/brand-folder/generated/schemas.d.ts +81 -0
- package/dist/services/brand-folder/generated/schemas.d.ts.map +1 -0
- package/dist/services/brand-folder/generated/types.d.ts +195 -0
- package/dist/services/brand-folder/generated/types.d.ts.map +1 -0
- package/dist/services/brand-folder/index.d.ts +2 -0
- package/dist/services/brand-folder/index.d.ts.map +1 -0
- package/dist/services/commerce/client.d.ts +57 -0
- package/dist/services/commerce/client.d.ts.map +1 -0
- package/dist/services/commerce/generated/endpoints.d.ts +42 -0
- package/dist/services/commerce/generated/endpoints.d.ts.map +1 -0
- package/dist/services/commerce/generated/schemas.d.ts +319 -0
- package/dist/services/commerce/generated/schemas.d.ts.map +1 -0
- package/dist/services/commerce/generated/types.d.ts +1134 -0
- package/dist/services/commerce/generated/types.d.ts.map +1 -0
- package/dist/services/commerce/index.d.ts +2 -0
- package/dist/services/commerce/index.d.ts.map +1 -0
- package/dist/services/customers/client.d.ts +162 -0
- package/dist/services/customers/client.d.ts.map +1 -0
- package/dist/services/customers/generated/endpoints.d.ts +42 -0
- package/dist/services/customers/generated/endpoints.d.ts.map +1 -0
- package/dist/services/customers/generated/schemas.d.ts +1970 -0
- package/dist/services/customers/generated/schemas.d.ts.map +1 -0
- package/dist/services/customers/generated/types.d.ts +3849 -0
- package/dist/services/customers/generated/types.d.ts.map +1 -0
- package/dist/services/customers/index.d.ts +2 -0
- package/dist/services/customers/index.d.ts.map +1 -0
- package/dist/services/goog-mc/client.d.ts +44 -0
- package/dist/services/goog-mc/client.d.ts.map +1 -0
- package/dist/services/goog-mc/generated/endpoints.d.ts +42 -0
- package/dist/services/goog-mc/generated/endpoints.d.ts.map +1 -0
- package/dist/services/goog-mc/generated/schemas.d.ts +175 -0
- package/dist/services/goog-mc/generated/schemas.d.ts.map +1 -0
- package/dist/services/goog-mc/generated/types.d.ts +361 -0
- package/dist/services/goog-mc/generated/types.d.ts.map +1 -0
- package/dist/services/goog-mc/index.d.ts +2 -0
- package/dist/services/goog-mc/index.d.ts.map +1 -0
- package/dist/services/gregorovich/client.d.ts +34 -0
- package/dist/services/gregorovich/client.d.ts.map +1 -0
- package/dist/services/gregorovich/generated/endpoints.d.ts +42 -0
- package/dist/services/gregorovich/generated/endpoints.d.ts.map +1 -0
- package/dist/services/gregorovich/generated/schemas.d.ts +35 -0
- package/dist/services/gregorovich/generated/schemas.d.ts.map +1 -0
- package/dist/services/gregorovich/generated/types.d.ts +70 -0
- package/dist/services/gregorovich/generated/types.d.ts.map +1 -0
- package/dist/services/gregorovich/index.d.ts +2 -0
- package/dist/services/gregorovich/index.d.ts.map +1 -0
- package/dist/services/items/client.d.ts +453 -0
- package/dist/services/items/client.d.ts.map +1 -0
- package/dist/services/items/generated/endpoints.d.ts +42 -0
- package/dist/services/items/generated/endpoints.d.ts.map +1 -0
- package/dist/services/items/generated/schemas.d.ts +4636 -0
- package/dist/services/items/generated/schemas.d.ts.map +1 -0
- package/dist/services/items/generated/types.d.ts +10513 -0
- package/dist/services/items/generated/types.d.ts.map +1 -0
- package/dist/services/items/index.d.ts +2 -0
- package/dist/services/items/index.d.ts.map +1 -0
- package/dist/services/joomla/client.d.ts +74 -0
- package/dist/services/joomla/client.d.ts.map +1 -0
- package/dist/services/joomla/generated/endpoints.d.ts +41 -0
- package/dist/services/joomla/generated/endpoints.d.ts.map +1 -0
- package/dist/services/joomla/generated/schemas.d.ts +546 -0
- package/dist/services/joomla/generated/schemas.d.ts.map +1 -0
- package/dist/services/joomla/generated/types.d.ts +1489 -0
- package/dist/services/joomla/generated/types.d.ts.map +1 -0
- package/dist/services/joomla/index.d.ts +2 -0
- package/dist/services/joomla/index.d.ts.map +1 -0
- package/dist/services/legacy/client.d.ts +75 -0
- package/dist/services/legacy/client.d.ts.map +1 -0
- package/dist/services/legacy/generated/endpoints.d.ts +41 -0
- package/dist/services/legacy/generated/endpoints.d.ts.map +1 -0
- package/dist/services/legacy/generated/schemas.d.ts +567 -0
- package/dist/services/legacy/generated/schemas.d.ts.map +1 -0
- package/dist/services/legacy/generated/types.d.ts +1454 -0
- package/dist/services/legacy/generated/types.d.ts.map +1 -0
- package/dist/services/legacy/index.d.ts +2 -0
- package/dist/services/legacy/index.d.ts.map +1 -0
- package/dist/services/logistics/client.d.ts +64 -0
- package/dist/services/logistics/client.d.ts.map +1 -0
- package/dist/services/logistics/generated/endpoints.d.ts +41 -0
- package/dist/services/logistics/generated/endpoints.d.ts.map +1 -0
- package/dist/services/logistics/generated/schemas.d.ts +375 -0
- package/dist/services/logistics/generated/schemas.d.ts.map +1 -0
- package/dist/services/logistics/generated/types.d.ts +925 -0
- package/dist/services/logistics/generated/types.d.ts.map +1 -0
- package/dist/services/logistics/index.d.ts +2 -0
- package/dist/services/logistics/index.d.ts.map +1 -0
- package/dist/services/markets/client.d.ts +47 -0
- package/dist/services/markets/client.d.ts.map +1 -0
- package/dist/services/markets/generated/endpoints.d.ts +41 -0
- package/dist/services/markets/generated/endpoints.d.ts.map +1 -0
- package/dist/services/markets/generated/schemas.d.ts +180 -0
- package/dist/services/markets/generated/schemas.d.ts.map +1 -0
- package/dist/services/markets/generated/types.d.ts +405 -0
- package/dist/services/markets/generated/types.d.ts.map +1 -0
- package/dist/services/markets/index.d.ts +2 -0
- package/dist/services/markets/index.d.ts.map +1 -0
- package/dist/services/notifications/client.d.ts +58 -0
- package/dist/services/notifications/client.d.ts.map +1 -0
- package/dist/services/notifications/generated/endpoints.d.ts +41 -0
- package/dist/services/notifications/generated/endpoints.d.ts.map +1 -0
- package/dist/services/notifications/generated/schemas.d.ts +247 -0
- package/dist/services/notifications/generated/schemas.d.ts.map +1 -0
- package/dist/services/notifications/generated/types.d.ts +666 -0
- package/dist/services/notifications/generated/types.d.ts.map +1 -0
- package/dist/services/notifications/index.d.ts +2 -0
- package/dist/services/notifications/index.d.ts.map +1 -0
- package/dist/services/open-search/client.d.ts +69 -0
- package/dist/services/open-search/client.d.ts.map +1 -0
- package/dist/services/open-search/generated/endpoints.d.ts +42 -0
- package/dist/services/open-search/generated/endpoints.d.ts.map +1 -0
- package/dist/services/open-search/generated/schemas.d.ts +363 -0
- package/dist/services/open-search/generated/schemas.d.ts.map +1 -0
- package/dist/services/open-search/generated/types.d.ts +983 -0
- package/dist/services/open-search/generated/types.d.ts.map +1 -0
- package/dist/services/open-search/index.d.ts +2 -0
- package/dist/services/open-search/index.d.ts.map +1 -0
- package/dist/services/orders/client.d.ts +180 -0
- package/dist/services/orders/client.d.ts.map +1 -0
- package/dist/services/orders/generated/endpoints.d.ts +42 -0
- package/dist/services/orders/generated/endpoints.d.ts.map +1 -0
- package/dist/services/orders/generated/schemas.d.ts +2479 -0
- package/dist/services/orders/generated/schemas.d.ts.map +1 -0
- package/dist/services/orders/generated/types.d.ts +4717 -0
- package/dist/services/orders/generated/types.d.ts.map +1 -0
- package/dist/services/orders/index.d.ts +2 -0
- package/dist/services/orders/index.d.ts.map +1 -0
- package/dist/services/p21-apis/client.d.ts +59 -0
- package/dist/services/p21-apis/client.d.ts.map +1 -0
- package/dist/services/p21-apis/generated/endpoints.d.ts +41 -0
- package/dist/services/p21-apis/generated/endpoints.d.ts.map +1 -0
- package/dist/services/p21-apis/generated/schemas.d.ts +46 -0
- package/dist/services/p21-apis/generated/schemas.d.ts.map +1 -0
- package/dist/services/p21-apis/generated/types.d.ts +246 -0
- package/dist/services/p21-apis/generated/types.d.ts.map +1 -0
- package/dist/services/p21-apis/index.d.ts +2 -0
- package/dist/services/p21-apis/index.d.ts.map +1 -0
- package/dist/services/p21-core/client.d.ts +131 -0
- package/dist/services/p21-core/client.d.ts.map +1 -0
- package/dist/services/p21-core/generated/endpoints.d.ts +42 -0
- package/dist/services/p21-core/generated/endpoints.d.ts.map +1 -0
- package/dist/services/p21-core/generated/schemas.d.ts +1478 -0
- package/dist/services/p21-core/generated/schemas.d.ts.map +1 -0
- package/dist/services/p21-core/generated/types.d.ts +2718 -0
- package/dist/services/p21-core/generated/types.d.ts.map +1 -0
- package/dist/services/p21-core/index.d.ts +2 -0
- package/dist/services/p21-core/index.d.ts.map +1 -0
- package/dist/services/p21-pim/client.d.ts +75 -0
- package/dist/services/p21-pim/client.d.ts.map +1 -0
- package/dist/services/p21-pim/generated/endpoints.d.ts +41 -0
- package/dist/services/p21-pim/generated/endpoints.d.ts.map +1 -0
- package/dist/services/p21-pim/generated/schemas.d.ts +383 -0
- package/dist/services/p21-pim/generated/schemas.d.ts.map +1 -0
- package/dist/services/p21-pim/generated/types.d.ts +933 -0
- package/dist/services/p21-pim/generated/types.d.ts.map +1 -0
- package/dist/services/p21-pim/index.d.ts +2 -0
- package/dist/services/p21-pim/index.d.ts.map +1 -0
- package/dist/services/p21-sism/client.d.ts +432 -0
- package/dist/services/p21-sism/client.d.ts.map +1 -0
- package/dist/services/p21-sism/generated/endpoints.d.ts +42 -0
- package/dist/services/p21-sism/generated/endpoints.d.ts.map +1 -0
- package/dist/services/p21-sism/generated/schemas.d.ts +2844 -0
- package/dist/services/p21-sism/generated/schemas.d.ts.map +1 -0
- package/dist/services/p21-sism/generated/types.d.ts +6977 -0
- package/dist/services/p21-sism/generated/types.d.ts.map +1 -0
- package/dist/services/p21-sism/index.d.ts +37 -0
- package/dist/services/p21-sism/index.d.ts.map +1 -0
- package/dist/services/payments/client.d.ts +77 -0
- package/dist/services/payments/client.d.ts.map +1 -0
- package/dist/services/payments/generated/endpoints.d.ts +42 -0
- package/dist/services/payments/generated/endpoints.d.ts.map +1 -0
- package/dist/services/payments/generated/schemas.d.ts +1015 -0
- package/dist/services/payments/generated/schemas.d.ts.map +1 -0
- package/dist/services/payments/generated/types.d.ts +1432 -0
- package/dist/services/payments/generated/types.d.ts.map +1 -0
- package/dist/services/payments/index.d.ts +2 -0
- package/dist/services/payments/index.d.ts.map +1 -0
- package/dist/services/pricing/client.d.ts +216 -0
- package/dist/services/pricing/client.d.ts.map +1 -0
- package/dist/services/pricing/generated/endpoints.d.ts +42 -0
- package/dist/services/pricing/generated/endpoints.d.ts.map +1 -0
- package/dist/services/pricing/generated/schemas.d.ts +2048 -0
- package/dist/services/pricing/generated/schemas.d.ts.map +1 -0
- package/dist/services/pricing/generated/types.d.ts +4257 -0
- package/dist/services/pricing/generated/types.d.ts.map +1 -0
- package/dist/services/pricing/index.d.ts +2 -0
- package/dist/services/pricing/index.d.ts.map +1 -0
- package/dist/services/shipping/client.d.ts +33 -0
- package/dist/services/shipping/client.d.ts.map +1 -0
- package/dist/services/shipping/generated/endpoints.d.ts +41 -0
- package/dist/services/shipping/generated/endpoints.d.ts.map +1 -0
- package/dist/services/shipping/generated/schemas.d.ts +29 -0
- package/dist/services/shipping/generated/schemas.d.ts.map +1 -0
- package/dist/services/shipping/generated/types.d.ts +116 -0
- package/dist/services/shipping/generated/types.d.ts.map +1 -0
- package/dist/services/shipping/index.d.ts +2 -0
- package/dist/services/shipping/index.d.ts.map +1 -0
- package/dist/services/smarty-streets/client.d.ts +33 -0
- package/dist/services/smarty-streets/client.d.ts.map +1 -0
- package/dist/services/smarty-streets/generated/endpoints.d.ts +41 -0
- package/dist/services/smarty-streets/generated/endpoints.d.ts.map +1 -0
- package/dist/services/smarty-streets/generated/schemas.d.ts +72 -0
- package/dist/services/smarty-streets/generated/schemas.d.ts.map +1 -0
- package/dist/services/smarty-streets/generated/types.d.ts +145 -0
- package/dist/services/smarty-streets/generated/types.d.ts.map +1 -0
- package/dist/services/smarty-streets/index.d.ts +2 -0
- package/dist/services/smarty-streets/index.d.ts.map +1 -0
- package/dist/services/ups/client.d.ts +32 -0
- package/dist/services/ups/client.d.ts.map +1 -0
- package/dist/services/ups/generated/endpoints.d.ts +40 -0
- package/dist/services/ups/generated/endpoints.d.ts.map +1 -0
- package/dist/services/ups/generated/schemas.d.ts +51 -0
- package/dist/services/ups/generated/schemas.d.ts.map +1 -0
- package/dist/services/ups/generated/types.d.ts +98 -0
- package/dist/services/ups/generated/types.d.ts.map +1 -0
- package/dist/services/ups/index.d.ts +2 -0
- package/dist/services/ups/index.d.ts.map +1 -0
- package/dist/services/vendors/client.d.ts +38 -0
- package/dist/services/vendors/client.d.ts.map +1 -0
- package/dist/services/vendors/generated/endpoints.d.ts +41 -0
- package/dist/services/vendors/generated/endpoints.d.ts.map +1 -0
- package/dist/services/vendors/generated/schemas.d.ts +350 -0
- package/dist/services/vendors/generated/schemas.d.ts.map +1 -0
- package/dist/services/vendors/generated/types.d.ts +470 -0
- package/dist/services/vendors/generated/types.d.ts.map +1 -0
- package/dist/services/vendors/index.d.ts +2 -0
- package/dist/services/vendors/index.d.ts.map +1 -0
- package/dist/services/vmi/client.d.ts +129 -0
- package/dist/services/vmi/client.d.ts.map +1 -0
- package/dist/services/vmi/generated/endpoints.d.ts +41 -0
- package/dist/services/vmi/generated/endpoints.d.ts.map +1 -0
- package/dist/services/vmi/generated/schemas.d.ts +723 -0
- package/dist/services/vmi/generated/schemas.d.ts.map +1 -0
- package/dist/services/vmi/generated/types.d.ts +2620 -0
- package/dist/services/vmi/generated/types.d.ts.map +1 -0
- package/dist/services/vmi/index.d.ts +2 -0
- package/dist/services/vmi/index.d.ts.map +1 -0
- package/dist/testing.d.ts +9 -13
- package/dist/testing.d.ts.map +1 -0
- package/dist/testing.js +7 -17
- package/dist/testing.js.map +1 -1
- package/dist/testing.mjs +7 -17
- package/dist/testing.mjs.map +1 -1
- package/dist/utils/cross-site-auth.d.ts +88 -0
- package/dist/utils/cross-site-auth.d.ts.map +1 -0
- package/package.json +34 -47
- package/dist/client-TPJa269Y.d.mts +0 -58610
- package/dist/client-TPJa269Y.d.ts +0 -58610
- package/dist/index.d.mts +0 -236
- package/dist/testing.d.mts +0 -83
|
@@ -0,0 +1,4257 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated types for the pricing service.
|
|
3
|
+
* Pricing engine with 4-stage waterfall calculation, price books, tax groups, and customer-specific
|
|
4
|
+
* rules
|
|
5
|
+
*
|
|
6
|
+
* Public specs (the source of truth for every shape below):
|
|
7
|
+
* https://pricing.augur-api.com/endpoints.jsonl: one JSON line per endpoint: method, path, path
|
|
8
|
+
* params and query params, each with type and required flag. Grep it for a path; for a GET
|
|
9
|
+
* that line is all you need. Bodies are not in it.
|
|
10
|
+
* https://pricing.augur-api.com/openapi.json: the full contract: request and response bodies
|
|
11
|
+
* field by field, descriptions, formats and documented errors.
|
|
12
|
+
* https://pricing.augur-api.com/llms.txt: the plain-text endpoint list and the other Augur
|
|
13
|
+
* services.
|
|
14
|
+
*
|
|
15
|
+
* Source: shared/specs/pricing.json
|
|
16
|
+
*
|
|
17
|
+
* DO NOT EDIT — regenerate with: pnpm -C tools/augur-api-generator generate ts
|
|
18
|
+
*/
|
|
19
|
+
import type { EdgeCacheParams } from "../../../core/common-schemas";
|
|
20
|
+
import type { BaseResponse } from "../../../core/schemas";
|
|
21
|
+
/** Params for GET /job-price-bin */
|
|
22
|
+
export interface JobPriceBinListParams extends EdgeCacheParams {
|
|
23
|
+
/** P21 customer ID (customer.customer_id) */
|
|
24
|
+
customerId?: number;
|
|
25
|
+
/** Job price line ID (job_price_line.job_price_line_uid) */
|
|
26
|
+
jobPriceLineUid?: number;
|
|
27
|
+
/** Maximum rows to return (Default: 10) */
|
|
28
|
+
limit?: number;
|
|
29
|
+
/** Starting offset results (Default: 0) */
|
|
30
|
+
offset?: number;
|
|
31
|
+
/** Order By (Default: job_price_bin_uid|ASC) */
|
|
32
|
+
orderBy?: string;
|
|
33
|
+
/**
|
|
34
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
35
|
+
* (704,705); -1 for every status. Default: 704
|
|
36
|
+
*/
|
|
37
|
+
rowStatusFlag?: number | number[];
|
|
38
|
+
/** P21 ship-to ID (ship_to.ship_to_id) */
|
|
39
|
+
shipToId?: number;
|
|
40
|
+
}
|
|
41
|
+
/** Params for GET /job-price-bin/{jobPriceBinUid} */
|
|
42
|
+
export type JobPriceBinGetParams = EdgeCacheParams;
|
|
43
|
+
/** Params for GET /job-price-customer-shipto */
|
|
44
|
+
export interface JobPriceCustomerShiptoListParams extends EdgeCacheParams {
|
|
45
|
+
/** P21 company ID */
|
|
46
|
+
companyId?: string;
|
|
47
|
+
/** P21 customer ID (customer.customer_id) */
|
|
48
|
+
customerId?: number;
|
|
49
|
+
/** Job price header ID (job_price_hdr.job_price_hdr_uid) */
|
|
50
|
+
jobPriceHdrUid?: number;
|
|
51
|
+
/** Maximum rows to return (Default: 10) */
|
|
52
|
+
limit?: number;
|
|
53
|
+
/** Starting offset results (Default: 0) */
|
|
54
|
+
offset?: number;
|
|
55
|
+
/** Order By (Default: job_price_cust_shipto_uid|ASC) */
|
|
56
|
+
orderBy?: string;
|
|
57
|
+
/**
|
|
58
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
59
|
+
* (704,705); -1 for every status. Default: 704
|
|
60
|
+
*/
|
|
61
|
+
rowStatusFlag?: number | number[];
|
|
62
|
+
/** P21 ship-to ID (ship_to.ship_to_id) */
|
|
63
|
+
shipToId?: number;
|
|
64
|
+
}
|
|
65
|
+
/** Params for GET /job-price-customer-shipto/{jobPriceCustShiptoUid} */
|
|
66
|
+
export type JobPriceCustomerShiptoGetParams = EdgeCacheParams;
|
|
67
|
+
/** Params for GET /job-price-hdr */
|
|
68
|
+
export interface JobPriceHdrListParams extends EdgeCacheParams {
|
|
69
|
+
/** Limit number of results (Default: 10) */
|
|
70
|
+
limit?: number;
|
|
71
|
+
/** Starting offset results (Default: 0) */
|
|
72
|
+
offset?: number;
|
|
73
|
+
/** Order By (Default: job_price_hdr_uid|ASC) */
|
|
74
|
+
orderBy?: string;
|
|
75
|
+
/** Search Query */
|
|
76
|
+
q?: string;
|
|
77
|
+
}
|
|
78
|
+
/** Params for GET /job-price-hdr/{jobPriceHdrUid} */
|
|
79
|
+
export type JobPriceHdrGetParams = EdgeCacheParams;
|
|
80
|
+
/** Params for GET /job-price-hdr/{jobPriceHdrUid}/lines */
|
|
81
|
+
export interface JobPriceHdrLinesListParams extends EdgeCacheParams {
|
|
82
|
+
/** Inventory Master UID */
|
|
83
|
+
invMastUid?: number;
|
|
84
|
+
/** Limit number of results (Default: 10) */
|
|
85
|
+
limit?: number;
|
|
86
|
+
/** Starting offset results (Default: 0) */
|
|
87
|
+
offset?: number;
|
|
88
|
+
/** Order By (Default: job_price_line_uid|ASC) */
|
|
89
|
+
orderBy?: string;
|
|
90
|
+
/** Search Query */
|
|
91
|
+
q?: string;
|
|
92
|
+
/** Status Code (status_cd) [(704)|(705)|(700)] */
|
|
93
|
+
statusCd?: number;
|
|
94
|
+
}
|
|
95
|
+
/** Params for GET /job-price-hdr/{jobPriceHdrUid}/lines/{jobPriceLineUid} */
|
|
96
|
+
export type JobPriceHdrLinesGetParams = EdgeCacheParams;
|
|
97
|
+
/** Params for GET /price-book */
|
|
98
|
+
export interface PriceBookListParams extends EdgeCacheParams {
|
|
99
|
+
/** P21 company ID */
|
|
100
|
+
companyId?: string;
|
|
101
|
+
/** Maximum rows to return (Default: 10) */
|
|
102
|
+
limit?: number;
|
|
103
|
+
/** Starting offset results (Default: 0) */
|
|
104
|
+
offset?: number;
|
|
105
|
+
/** Order By (Default: price_book_uid|ASC) */
|
|
106
|
+
orderBy?: string;
|
|
107
|
+
/**
|
|
108
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
109
|
+
* (704,705); -1 for every status. Default: 704
|
|
110
|
+
*/
|
|
111
|
+
rowStatusFlag?: number | number[];
|
|
112
|
+
}
|
|
113
|
+
/** Params for GET /price-book-x-library */
|
|
114
|
+
export interface PriceBookXLibraryListParams extends EdgeCacheParams {
|
|
115
|
+
/** Maximum rows to return (Default: 10) */
|
|
116
|
+
limit?: number;
|
|
117
|
+
/** Starting offset results (Default: 0) */
|
|
118
|
+
offset?: number;
|
|
119
|
+
/** Order By (Default: price_book_x_library_uid|ASC) */
|
|
120
|
+
orderBy?: string;
|
|
121
|
+
/** Price book ID (price_book.price_book_uid) to list library links for */
|
|
122
|
+
priceBookUid?: number;
|
|
123
|
+
/** Price library ID (price_library.price_library_uid) to list book links for */
|
|
124
|
+
priceLibraryUid?: number;
|
|
125
|
+
/**
|
|
126
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
127
|
+
* (704,705); -1 for every status. Default: 704
|
|
128
|
+
*/
|
|
129
|
+
rowStatusFlag?: number | number[];
|
|
130
|
+
}
|
|
131
|
+
/** Params for GET /price-book-x-library/{priceBookXLibraryUid} */
|
|
132
|
+
export type PriceBookXLibraryGetParams = EdgeCacheParams;
|
|
133
|
+
/** Params for GET /price-book/{priceBookUid} */
|
|
134
|
+
export type PriceBookGetParams = EdgeCacheParams;
|
|
135
|
+
/** Params for GET /price-engine */
|
|
136
|
+
export interface PriceEngineListParams extends EdgeCacheParams {
|
|
137
|
+
/** Cart items for group break pricing (format: itemId:qty[:UOM],itemId:qty[:UOM]) */
|
|
138
|
+
cartItems?: string;
|
|
139
|
+
/** Prophet 21 customer to price for; MUST be above 0 */
|
|
140
|
+
customerId: number;
|
|
141
|
+
/** Prophet 21 item ID to price */
|
|
142
|
+
itemId: string;
|
|
143
|
+
/** Quantity to price, for quantity breaks (Default: 1) */
|
|
144
|
+
quantity?: number;
|
|
145
|
+
/**
|
|
146
|
+
* Prophet 21 ship-to that selects the pricing location (Default: the customer default ship-to)
|
|
147
|
+
*/
|
|
148
|
+
shipToId?: number;
|
|
149
|
+
/** Unit of measure to price in (Default: the item sales unit) */
|
|
150
|
+
unitOfMeasure?: string;
|
|
151
|
+
}
|
|
152
|
+
/** Params for GET /price-family */
|
|
153
|
+
export interface PriceFamilyListParams extends EdgeCacheParams {
|
|
154
|
+
/** Maximum rows to return (Default: 10) */
|
|
155
|
+
limit?: number;
|
|
156
|
+
/** Starting offset results (Default: 0) */
|
|
157
|
+
offset?: number;
|
|
158
|
+
/** Order By (Default: price_family_uid|ASC) */
|
|
159
|
+
orderBy?: string;
|
|
160
|
+
/** P21 price family ID (the family name) */
|
|
161
|
+
priceFamilyId?: string;
|
|
162
|
+
/**
|
|
163
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
164
|
+
* (704,705); -1 for every status. Default: 704
|
|
165
|
+
*/
|
|
166
|
+
rowStatusFlag?: number | number[];
|
|
167
|
+
}
|
|
168
|
+
/** Params for GET /price-family-x-restricted-class */
|
|
169
|
+
export interface PriceFamilyXRestrictedClassListParams extends EdgeCacheParams {
|
|
170
|
+
/** Maximum rows to return (Default: 10) */
|
|
171
|
+
limit?: number;
|
|
172
|
+
/** Starting offset results (Default: 0) */
|
|
173
|
+
offset?: number;
|
|
174
|
+
/** Order By (Default: price_family_x_restricted_class_uid|ASC) */
|
|
175
|
+
orderBy?: string;
|
|
176
|
+
/** Price family ID (price_family.price_family_uid) */
|
|
177
|
+
priceFamilyUid?: number;
|
|
178
|
+
/** Restricted class ID (restricted_class.restricted_class_uid) */
|
|
179
|
+
restrictedClassUid?: number;
|
|
180
|
+
/**
|
|
181
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
182
|
+
* (704,705); -1 for every status. Default: 704
|
|
183
|
+
*/
|
|
184
|
+
rowStatusFlag?: number | number[];
|
|
185
|
+
}
|
|
186
|
+
/** Params for GET /price-family-x-restricted-class/{priceFamilyXRestrictedClassUid} */
|
|
187
|
+
export type PriceFamilyXRestrictedClassGetParams = EdgeCacheParams;
|
|
188
|
+
/** Params for GET /price-family/{priceFamilyUid} */
|
|
189
|
+
export type PriceFamilyGetParams = EdgeCacheParams;
|
|
190
|
+
/** Params for GET /price-library */
|
|
191
|
+
export interface PriceLibraryListParams extends EdgeCacheParams {
|
|
192
|
+
/** P21 company ID */
|
|
193
|
+
companyId?: string;
|
|
194
|
+
/** Maximum rows to return (Default: 10) */
|
|
195
|
+
limit?: number;
|
|
196
|
+
/** Starting offset results (Default: 0) */
|
|
197
|
+
offset?: number;
|
|
198
|
+
/** Order By (Default: price_library_uid|ASC) */
|
|
199
|
+
orderBy?: string;
|
|
200
|
+
/** P21 price library ID (the library name) */
|
|
201
|
+
priceLibraryId?: string;
|
|
202
|
+
/**
|
|
203
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
204
|
+
* (704,705); -1 for every status. Default: 704
|
|
205
|
+
*/
|
|
206
|
+
rowStatusFlag?: number | number[];
|
|
207
|
+
}
|
|
208
|
+
/** Params for GET /price-library-x-cust-x-cmpy */
|
|
209
|
+
export interface PriceLibraryXCustXCmpyListParams extends EdgeCacheParams {
|
|
210
|
+
/** P21 company ID */
|
|
211
|
+
companyId?: string;
|
|
212
|
+
/** P21 customer ID (customer.customer_id) to list library links for */
|
|
213
|
+
customerId?: number;
|
|
214
|
+
/** Maximum rows to return (Default: 10) */
|
|
215
|
+
limit?: number;
|
|
216
|
+
/** Starting offset results (Default: 0) */
|
|
217
|
+
offset?: number;
|
|
218
|
+
/** Order By (Default: price_lib_x_cust_x_cmpy_uid|ASC) */
|
|
219
|
+
orderBy?: string;
|
|
220
|
+
/** Price library ID (price_library.price_library_uid) to list customer links for */
|
|
221
|
+
priceLibraryUid?: number;
|
|
222
|
+
/**
|
|
223
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
224
|
+
* (704,705); -1 for every status. Default: 704
|
|
225
|
+
*/
|
|
226
|
+
rowStatusFlag?: number | number[];
|
|
227
|
+
}
|
|
228
|
+
/** Params for GET /price-library-x-cust-x-cmpy/{priceLibXCustXCmpyUid} */
|
|
229
|
+
export type PriceLibraryXCustXCmpyGetParams = EdgeCacheParams;
|
|
230
|
+
/** Params for GET /price-library-x-ship-to */
|
|
231
|
+
export interface PriceLibraryXShipToListParams extends EdgeCacheParams {
|
|
232
|
+
/** P21 company ID */
|
|
233
|
+
companyId?: string;
|
|
234
|
+
/** Maximum rows to return (Default: 10) */
|
|
235
|
+
limit?: number;
|
|
236
|
+
/** Starting offset results (Default: 0) */
|
|
237
|
+
offset?: number;
|
|
238
|
+
/** Order By (Default: price_library_x_ship_to_uid|ASC) */
|
|
239
|
+
orderBy?: string;
|
|
240
|
+
/** Price library ID (price_library.price_library_uid) to list ship-to links for */
|
|
241
|
+
priceLibraryUid?: number;
|
|
242
|
+
/**
|
|
243
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
244
|
+
* (704,705); -1 for every status. Default: 704
|
|
245
|
+
*/
|
|
246
|
+
rowStatusFlag?: number | number[];
|
|
247
|
+
/** P21 ship-to ID (ship_to.ship_to_id) to list library links for */
|
|
248
|
+
shipToId?: number;
|
|
249
|
+
}
|
|
250
|
+
/** Params for GET /price-library-x-ship-to/{priceLibraryXShipToUid} */
|
|
251
|
+
export type PriceLibraryXShipToGetParams = EdgeCacheParams;
|
|
252
|
+
/** Params for GET /price-library/{priceLibraryUid} */
|
|
253
|
+
export type PriceLibraryGetParams = EdgeCacheParams;
|
|
254
|
+
/** Params for GET /price-method-x-customer */
|
|
255
|
+
export interface PriceMethodXCustomerListParams extends EdgeCacheParams {
|
|
256
|
+
/** P21 company ID */
|
|
257
|
+
companyId?: string;
|
|
258
|
+
/** P21 customer ID (customer.customer_id) */
|
|
259
|
+
customerId?: number;
|
|
260
|
+
/** Maximum rows to return (Default: 10) */
|
|
261
|
+
limit?: number;
|
|
262
|
+
/** Starting offset results (Default: 0) */
|
|
263
|
+
offset?: number;
|
|
264
|
+
/** Order By (Default: price_method_x_customer_uid|ASC) */
|
|
265
|
+
orderBy?: string;
|
|
266
|
+
/** Price method ID (price_method.price_method_uid) */
|
|
267
|
+
priceMethodUid?: number;
|
|
268
|
+
/** P21 ship-to ID (ship_to.ship_to_id) */
|
|
269
|
+
shipToId?: number;
|
|
270
|
+
}
|
|
271
|
+
/** Params for GET /price-method-x-customer/{priceMethodXCustomerUid} */
|
|
272
|
+
export type PriceMethodXCustomerGetParams = EdgeCacheParams;
|
|
273
|
+
/** Params for GET /price-page */
|
|
274
|
+
export interface PricePageListParams extends EdgeCacheParams {
|
|
275
|
+
/** P21 company ID */
|
|
276
|
+
companyId?: string;
|
|
277
|
+
/** Item ID (inv_mast.inv_mast_uid) */
|
|
278
|
+
invMastUid?: number;
|
|
279
|
+
/** Maximum rows to return (Default: 10) */
|
|
280
|
+
limit?: number;
|
|
281
|
+
/** Starting offset results (Default: 0) */
|
|
282
|
+
offset?: number;
|
|
283
|
+
/** Order By (Default: price_page_uid|ASC) */
|
|
284
|
+
orderBy?: string;
|
|
285
|
+
/** Price family ID (price_family.price_family_uid) */
|
|
286
|
+
priceFamilyUid?: number;
|
|
287
|
+
/**
|
|
288
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
289
|
+
* (704,705); -1 for every status. Default: 704
|
|
290
|
+
*/
|
|
291
|
+
rowStatusFlag?: number | number[];
|
|
292
|
+
/** P21 supplier ID (supplier.supplier_id) */
|
|
293
|
+
supplierId?: number;
|
|
294
|
+
}
|
|
295
|
+
/** Params for GET /price-page-dealer-commission */
|
|
296
|
+
export interface PricePageDealerCommissionListParams extends EdgeCacheParams {
|
|
297
|
+
/** Maximum rows to return (Default: 10) */
|
|
298
|
+
limit?: number;
|
|
299
|
+
/** Starting offset results (Default: 0) */
|
|
300
|
+
offset?: number;
|
|
301
|
+
/** Order By (Default: price_page_dealer_comm_uid|ASC) */
|
|
302
|
+
orderBy?: string;
|
|
303
|
+
/** Price page ID (price_page.price_page_uid) */
|
|
304
|
+
pricePageUid?: number;
|
|
305
|
+
}
|
|
306
|
+
/** Params for GET /price-page-dealer-commission/{pricePageDealerCommUid} */
|
|
307
|
+
export type PricePageDealerCommissionGetParams = EdgeCacheParams;
|
|
308
|
+
/** Params for GET /price-page-item */
|
|
309
|
+
export interface PricePageItemListParams extends EdgeCacheParams {
|
|
310
|
+
/** Maximum rows to return (Default: 10) */
|
|
311
|
+
limit?: number;
|
|
312
|
+
/** Starting offset results (Default: 0) */
|
|
313
|
+
offset?: number;
|
|
314
|
+
/** Order By (Default: price_page_item_uid|ASC) */
|
|
315
|
+
orderBy?: string;
|
|
316
|
+
/** Price page ID (price_page.price_page_uid) */
|
|
317
|
+
pricePageUid?: number;
|
|
318
|
+
}
|
|
319
|
+
/** Params for GET /price-page-item/{pricePageItemUid} */
|
|
320
|
+
export type PricePageItemGetParams = EdgeCacheParams;
|
|
321
|
+
/** Params for GET /price-page-po-cost-calc */
|
|
322
|
+
export interface PricePagePoCostCalcListParams extends EdgeCacheParams {
|
|
323
|
+
/** Maximum rows to return (Default: 10) */
|
|
324
|
+
limit?: number;
|
|
325
|
+
/** Starting offset results (Default: 0) */
|
|
326
|
+
offset?: number;
|
|
327
|
+
/** Order By (Default: price_page_po_cost_calc_uid|ASC) */
|
|
328
|
+
orderBy?: string;
|
|
329
|
+
/** Price page ID (price_page.price_page_uid) */
|
|
330
|
+
pricePageUid?: number;
|
|
331
|
+
}
|
|
332
|
+
/** Params for GET /price-page-po-cost-calc/{pricePagePoCostCalcUid} */
|
|
333
|
+
export type PricePagePoCostCalcGetParams = EdgeCacheParams;
|
|
334
|
+
/** Params for GET /price-page-pricefam */
|
|
335
|
+
export interface PricePagePricefamListParams extends EdgeCacheParams {
|
|
336
|
+
/** Maximum rows to return (Default: 10) */
|
|
337
|
+
limit?: number;
|
|
338
|
+
/** Starting offset results (Default: 0) */
|
|
339
|
+
offset?: number;
|
|
340
|
+
/** Order By (Default: price_page_pricefam_uid|ASC) */
|
|
341
|
+
orderBy?: string;
|
|
342
|
+
/** Price page ID (price_page.price_page_uid) */
|
|
343
|
+
pricePageUid?: number;
|
|
344
|
+
}
|
|
345
|
+
/** Params for GET /price-page-pricefam/{pricePagePricefamUid} */
|
|
346
|
+
export type PricePagePricefamGetParams = EdgeCacheParams;
|
|
347
|
+
/** Params for GET /price-page-prodgrp */
|
|
348
|
+
export interface PricePageProdgrpListParams extends EdgeCacheParams {
|
|
349
|
+
/** Maximum rows to return (Default: 10) */
|
|
350
|
+
limit?: number;
|
|
351
|
+
/** Starting offset results (Default: 0) */
|
|
352
|
+
offset?: number;
|
|
353
|
+
/** Order By (Default: price_page_prodgrp_uid|ASC) */
|
|
354
|
+
orderBy?: string;
|
|
355
|
+
/** Price page ID (price_page.price_page_uid) */
|
|
356
|
+
pricePageUid?: number;
|
|
357
|
+
}
|
|
358
|
+
/** Params for GET /price-page-prodgrp/{pricePageProdgrpUid} */
|
|
359
|
+
export type PricePageProdgrpGetParams = EdgeCacheParams;
|
|
360
|
+
/** Params for GET /price-page-secondary-rebate */
|
|
361
|
+
export interface PricePageSecondaryRebateListParams extends EdgeCacheParams {
|
|
362
|
+
/** Maximum rows to return (Default: 10) */
|
|
363
|
+
limit?: number;
|
|
364
|
+
/** Starting offset results (Default: 0) */
|
|
365
|
+
offset?: number;
|
|
366
|
+
/** Order By (Default: price_page_secondary_rebate_uid|ASC) */
|
|
367
|
+
orderBy?: string;
|
|
368
|
+
/** Price page ID (price_page.price_page_uid) */
|
|
369
|
+
pricePageUid?: number;
|
|
370
|
+
}
|
|
371
|
+
/** Params for GET /price-page-secondary-rebate/{pricePageSecondaryRebateUid} */
|
|
372
|
+
export type PricePageSecondaryRebateGetParams = EdgeCacheParams;
|
|
373
|
+
/** Params for GET /price-page-suppdisc */
|
|
374
|
+
export interface PricePageSuppdiscListParams extends EdgeCacheParams {
|
|
375
|
+
/** Maximum rows to return (Default: 10) */
|
|
376
|
+
limit?: number;
|
|
377
|
+
/** Starting offset results (Default: 0) */
|
|
378
|
+
offset?: number;
|
|
379
|
+
/** Order By (Default: price_page_suppdisc_uid|ASC) */
|
|
380
|
+
orderBy?: string;
|
|
381
|
+
/** Price page ID (price_page.price_page_uid) */
|
|
382
|
+
pricePageUid?: number;
|
|
383
|
+
}
|
|
384
|
+
/** Params for GET /price-page-suppdisc/{pricePageSuppdiscUid} */
|
|
385
|
+
export type PricePageSuppdiscGetParams = EdgeCacheParams;
|
|
386
|
+
/** Params for GET /price-page-supplier */
|
|
387
|
+
export interface PricePageSupplierListParams extends EdgeCacheParams {
|
|
388
|
+
/** Maximum rows to return (Default: 10) */
|
|
389
|
+
limit?: number;
|
|
390
|
+
/** Starting offset results (Default: 0) */
|
|
391
|
+
offset?: number;
|
|
392
|
+
/** Order By (Default: price_page_supplier_uid|ASC) */
|
|
393
|
+
orderBy?: string;
|
|
394
|
+
/** Price page ID (price_page.price_page_uid) */
|
|
395
|
+
pricePageUid?: number;
|
|
396
|
+
}
|
|
397
|
+
/** Params for GET /price-page-supplier/{pricePageSupplierUid} */
|
|
398
|
+
export type PricePageSupplierGetParams = EdgeCacheParams;
|
|
399
|
+
/** Params for GET /price-page-type-x-company */
|
|
400
|
+
export interface PricePageTypeXCompanyListParams extends EdgeCacheParams {
|
|
401
|
+
/** P21 company ID */
|
|
402
|
+
companyId?: string;
|
|
403
|
+
/** Maximum rows to return (Default: 10) */
|
|
404
|
+
limit?: number;
|
|
405
|
+
/** Starting offset results (Default: 0) */
|
|
406
|
+
offset?: number;
|
|
407
|
+
/** Order By (Default: price_page_type_x_company_uid|ASC) */
|
|
408
|
+
orderBy?: string;
|
|
409
|
+
}
|
|
410
|
+
/** Params for GET /price-page-type-x-company/{pricePageTypeXCompanyUid} */
|
|
411
|
+
export type PricePageTypeXCompanyGetParams = EdgeCacheParams;
|
|
412
|
+
/** Params for GET /price-page-x-book */
|
|
413
|
+
export interface PricePageXBookListParams extends EdgeCacheParams {
|
|
414
|
+
/** Maximum rows to return (Default: 10) */
|
|
415
|
+
limit?: number;
|
|
416
|
+
/** Starting offset results (Default: 0) */
|
|
417
|
+
offset?: number;
|
|
418
|
+
/** Order By (Default: price_page_x_book_uid|ASC) */
|
|
419
|
+
orderBy?: string;
|
|
420
|
+
/** Price book ID (price_book.price_book_uid) to list page links for */
|
|
421
|
+
priceBookUid?: number;
|
|
422
|
+
/** Price page ID (price_page.price_page_uid) to list book links for */
|
|
423
|
+
pricePageUid?: number;
|
|
424
|
+
/**
|
|
425
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
426
|
+
* (704,705); -1 for every status. Default: 704
|
|
427
|
+
*/
|
|
428
|
+
rowStatusFlag?: number | number[];
|
|
429
|
+
}
|
|
430
|
+
/** Params for GET /price-page-x-book/{pricePageXBookUid} */
|
|
431
|
+
export type PricePageXBookGetParams = EdgeCacheParams;
|
|
432
|
+
/** Params for GET /price-page/{pricePageUid} */
|
|
433
|
+
export type PricePageGetParams = EdgeCacheParams;
|
|
434
|
+
/** Params for GET /price-source-x-company */
|
|
435
|
+
export interface PriceSourceXCompanyListParams extends EdgeCacheParams {
|
|
436
|
+
/** P21 company ID */
|
|
437
|
+
companyId?: string;
|
|
438
|
+
/** Maximum rows to return (Default: 10) */
|
|
439
|
+
limit?: number;
|
|
440
|
+
/** Starting offset results (Default: 0) */
|
|
441
|
+
offset?: number;
|
|
442
|
+
/** Order By (Default: price_source_x_company_uid|ASC) */
|
|
443
|
+
orderBy?: string;
|
|
444
|
+
}
|
|
445
|
+
/** Params for GET /price-source-x-company/{priceSourceXCompanyUid} */
|
|
446
|
+
export type PriceSourceXCompanyGetParams = EdgeCacheParams;
|
|
447
|
+
/** Params for GET /tax-group-hdr */
|
|
448
|
+
export interface TaxGroupHdrListParams extends EdgeCacheParams {
|
|
449
|
+
/** P21 company ID */
|
|
450
|
+
companyId?: string;
|
|
451
|
+
/** P21 delete flag to filter by: Y or N (Default: every row) */
|
|
452
|
+
deleteFlag?: string;
|
|
453
|
+
/** Maximum rows to return (Default: 10) */
|
|
454
|
+
limit?: number;
|
|
455
|
+
/** Starting offset results (Default: 0) */
|
|
456
|
+
offset?: number;
|
|
457
|
+
/** Order By (Default: tax_group_id|ASC) */
|
|
458
|
+
orderBy?: string;
|
|
459
|
+
/** P21 tax group ID */
|
|
460
|
+
taxGroupId?: string;
|
|
461
|
+
}
|
|
462
|
+
/** Params for GET /tax-group-hdr-zip */
|
|
463
|
+
export interface TaxGroupHdrZipListParams extends EdgeCacheParams {
|
|
464
|
+
/** P21 company ID */
|
|
465
|
+
companyId?: string;
|
|
466
|
+
/** Maximum rows to return (Default: 10) */
|
|
467
|
+
limit?: number;
|
|
468
|
+
/** Starting offset results (Default: 0) */
|
|
469
|
+
offset?: number;
|
|
470
|
+
/** Order By (Default: tax_group_hdr_zip_uid|ASC) */
|
|
471
|
+
orderBy?: string;
|
|
472
|
+
/**
|
|
473
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
474
|
+
* (704,705); -1 for every status. Default: 704
|
|
475
|
+
*/
|
|
476
|
+
statusCd?: number | number[];
|
|
477
|
+
/** P21 tax group ID (tax_group_hdr.tax_group_id) */
|
|
478
|
+
taxGroupId?: string;
|
|
479
|
+
}
|
|
480
|
+
/** Params for GET /tax-group-hdr-zip/{taxGroupHdrZipUid} */
|
|
481
|
+
export type TaxGroupHdrZipGetParams = EdgeCacheParams;
|
|
482
|
+
/** Params for GET /tax-group-line */
|
|
483
|
+
export interface TaxGroupLineListParams extends EdgeCacheParams {
|
|
484
|
+
/** P21 company ID */
|
|
485
|
+
companyId?: string;
|
|
486
|
+
/** P21 delete flag to filter by: Y or N (Default: every row) */
|
|
487
|
+
deleteFlag?: string;
|
|
488
|
+
/** P21 tax jurisdiction ID (tax_jurisdiction.jurisdiction_id) */
|
|
489
|
+
jurisdictionId?: string;
|
|
490
|
+
/** Maximum rows to return (Default: 10) */
|
|
491
|
+
limit?: number;
|
|
492
|
+
/** Starting offset results (Default: 0) */
|
|
493
|
+
offset?: number;
|
|
494
|
+
/** Order By (Default: tax_group_id|ASC) */
|
|
495
|
+
orderBy?: string;
|
|
496
|
+
/** P21 tax group ID (tax_group_hdr.tax_group_id) */
|
|
497
|
+
taxGroupId?: string;
|
|
498
|
+
}
|
|
499
|
+
/** Params for GET /tax-jurisdiction */
|
|
500
|
+
export interface TaxJurisdictionListParams extends EdgeCacheParams {
|
|
501
|
+
/** P21 delete flag to filter by: Y or N (Default: every row) */
|
|
502
|
+
deleteFlag?: string;
|
|
503
|
+
/** Maximum rows to return (Default: 10) */
|
|
504
|
+
limit?: number;
|
|
505
|
+
/** Starting offset results (Default: 0) */
|
|
506
|
+
offset?: number;
|
|
507
|
+
/** Order By (Default: jurisdiction_id|ASC) */
|
|
508
|
+
orderBy?: string;
|
|
509
|
+
}
|
|
510
|
+
/** Params for GET /tax-jurisdiction/{jurisdictionId} */
|
|
511
|
+
export type TaxJurisdictionGetParams = EdgeCacheParams;
|
|
512
|
+
/** Params for GET /web-pricing */
|
|
513
|
+
export interface WebPricingListParams extends EdgeCacheParams {
|
|
514
|
+
/** Limit number of results (Default: 10) */
|
|
515
|
+
limit?: number;
|
|
516
|
+
/** Starting offset results (Default: 0) */
|
|
517
|
+
offset?: number;
|
|
518
|
+
/** Order By (Default: web_pricing_uid|ASC) */
|
|
519
|
+
orderBy?: string;
|
|
520
|
+
/**
|
|
521
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
522
|
+
* (704,705); -1 for every status. Default: 704
|
|
523
|
+
*/
|
|
524
|
+
statusCd?: number | number[];
|
|
525
|
+
}
|
|
526
|
+
/** Params for GET /web-pricing/{webPricingUid} */
|
|
527
|
+
export type WebPricingGetParams = EdgeCacheParams;
|
|
528
|
+
/** Params for GET /web-pricing/{webPricingUid}/customers */
|
|
529
|
+
export interface WebPricingCustomersListParams extends EdgeCacheParams {
|
|
530
|
+
/** Limit number of results (Default: 10) */
|
|
531
|
+
limit?: number;
|
|
532
|
+
/** Starting offset results (Default: 0) */
|
|
533
|
+
offset?: number;
|
|
534
|
+
/** Order By (Default: web_pricing_x_customer_uid|ASC) */
|
|
535
|
+
orderBy?: string;
|
|
536
|
+
/**
|
|
537
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
538
|
+
* (704,705); -1 for every status. Default: 704
|
|
539
|
+
*/
|
|
540
|
+
statusCd?: number | number[];
|
|
541
|
+
}
|
|
542
|
+
/** Params for GET /web-pricing/{webPricingUid}/customers/{customerId} */
|
|
543
|
+
export type WebPricingCustomersGetParams = EdgeCacheParams;
|
|
544
|
+
/**
|
|
545
|
+
* List Job Price Bins
|
|
546
|
+
* Response data for GET /job-price-bin — MINIMUM fields, extras pass through
|
|
547
|
+
*
|
|
548
|
+
* Returned by: api.pricing.jobPriceBin.list(params) (array items)
|
|
549
|
+
* Returned by: api.pricing.jobPriceBin.get(jobPriceBinUid)
|
|
550
|
+
*/
|
|
551
|
+
export interface JobPriceBinListItem {
|
|
552
|
+
/** Job price bin ID */
|
|
553
|
+
jobPriceBinUid: number;
|
|
554
|
+
/** Job price line ID */
|
|
555
|
+
jobPriceLineUid: number;
|
|
556
|
+
/** P21 customer ID (customer.customer_id) */
|
|
557
|
+
customerId: number;
|
|
558
|
+
/** P21 ship-to ID (ship_to.ship_to_id) */
|
|
559
|
+
shipToId: number;
|
|
560
|
+
/** P21 contract bin ID (max 255 chars) */
|
|
561
|
+
contractBinId: string;
|
|
562
|
+
/** P21 unit of measure for the bin (max 8 chars) */
|
|
563
|
+
uom: string;
|
|
564
|
+
/** P21 bin capacity */
|
|
565
|
+
capacity: number | null;
|
|
566
|
+
/** P21 minimum quantity */
|
|
567
|
+
minQty: number | null;
|
|
568
|
+
/** P21 maximum quantity */
|
|
569
|
+
maxQty: number | null;
|
|
570
|
+
/** P21 reorder quantity */
|
|
571
|
+
reorderQty: number | null;
|
|
572
|
+
/** Row status from P21 (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
573
|
+
rowStatusFlag: number;
|
|
574
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
575
|
+
dateCreated: string;
|
|
576
|
+
/** P21 user who created the row (max 255 chars) */
|
|
577
|
+
createdBy: string;
|
|
578
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
579
|
+
dateLastModified: string;
|
|
580
|
+
/** P21 user who last changed the row (max 255 chars) */
|
|
581
|
+
lastMaintainedBy: string;
|
|
582
|
+
/** Customer PO number (max 255 chars) */
|
|
583
|
+
custPoNo: string | null;
|
|
584
|
+
/** P21 contract part number (max 255 chars) */
|
|
585
|
+
contractPartNo: string | null;
|
|
586
|
+
/** P21 line (max 255 chars) */
|
|
587
|
+
line: string | null;
|
|
588
|
+
/** P21 line feed (max 255 chars) */
|
|
589
|
+
lineFeed: string | null;
|
|
590
|
+
/** P21 line station (max 255 chars) */
|
|
591
|
+
lineStation: string | null;
|
|
592
|
+
/** P21 quantity ordered */
|
|
593
|
+
qtyOrdered: number | null;
|
|
594
|
+
/** P21 number of containers */
|
|
595
|
+
noOfContainers: number | null;
|
|
596
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
597
|
+
updateCd: number;
|
|
598
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
599
|
+
processCd: number;
|
|
600
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
601
|
+
statusCd: number;
|
|
602
|
+
[key: string]: unknown;
|
|
603
|
+
}
|
|
604
|
+
/** Returned by: api.pricing.jobPriceBin.list(params) */
|
|
605
|
+
export type JobPriceBinListData = JobPriceBinListItem[];
|
|
606
|
+
/**
|
|
607
|
+
* Get Job Price Bin
|
|
608
|
+
* Response data for GET /job-price-bin/{jobPriceBinUid} — MINIMUM fields, extras pass through
|
|
609
|
+
*
|
|
610
|
+
* Returned by: api.pricing.jobPriceBin.get(jobPriceBinUid)
|
|
611
|
+
*/
|
|
612
|
+
export type JobPriceBinGetData = JobPriceBinListItem;
|
|
613
|
+
/**
|
|
614
|
+
* List Job Price Customer Ship-to Rows
|
|
615
|
+
* Response data for GET /job-price-customer-shipto — MINIMUM fields, extras pass through
|
|
616
|
+
*
|
|
617
|
+
* Returned by: api.pricing.jobPriceCustomerShipto.list(params) (array items)
|
|
618
|
+
* Returned by: api.pricing.jobPriceCustomerShipto.get(jobPriceCustShiptoUid)
|
|
619
|
+
*/
|
|
620
|
+
export interface JobPriceCustomerShiptoListItem {
|
|
621
|
+
/** Job price customer ship-to ID */
|
|
622
|
+
jobPriceCustShiptoUid: number;
|
|
623
|
+
/** Job price header ID */
|
|
624
|
+
jobPriceHdrUid: number;
|
|
625
|
+
/** P21 company ID (max 8 chars) */
|
|
626
|
+
companyId: string;
|
|
627
|
+
/** P21 customer ID (customer.customer_id) */
|
|
628
|
+
customerId: number;
|
|
629
|
+
/** P21 ship-to ID (ship_to.ship_to_id) */
|
|
630
|
+
shipToId: number;
|
|
631
|
+
/** P21 preferred location ID */
|
|
632
|
+
preferredLocationId: number | null;
|
|
633
|
+
/** P21 terms ID (max 2 chars) */
|
|
634
|
+
termsId: string | null;
|
|
635
|
+
/** P21 consolidated_invoicing flag (max 1 chars) */
|
|
636
|
+
consolidatedInvoicing: string | null;
|
|
637
|
+
/** P21 acceptable wait time */
|
|
638
|
+
acceptableWaitTime: number | null;
|
|
639
|
+
/** P21 default disposition (max 1 chars) */
|
|
640
|
+
defaultDisposition: string | null;
|
|
641
|
+
/** P21 default carrier ID */
|
|
642
|
+
defaultCarrierId: number | null;
|
|
643
|
+
/** P21 freight code ID */
|
|
644
|
+
freightCdUid: number | null;
|
|
645
|
+
/** P21 contract dollar limit */
|
|
646
|
+
contractDollarLimit: number | null;
|
|
647
|
+
/** P21 ship-to contact ID (max 16 chars) */
|
|
648
|
+
shipToContactId: string | null;
|
|
649
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
650
|
+
dateCreated: string;
|
|
651
|
+
/** P21 user who created the row (max 255 chars) */
|
|
652
|
+
createdBy: string;
|
|
653
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
654
|
+
dateLastModified: string;
|
|
655
|
+
/** P21 user who last changed the row (max 255 chars) */
|
|
656
|
+
lastMaintainedBy: string;
|
|
657
|
+
/** Row status from P21 (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
658
|
+
rowStatusFlag: number;
|
|
659
|
+
/** P21 location ID */
|
|
660
|
+
locationId: number | null;
|
|
661
|
+
/** P21 contract dollar limit used */
|
|
662
|
+
contractDollarLimitUsed: number;
|
|
663
|
+
/** Customer PO number (max 255 chars) */
|
|
664
|
+
custPoNo: string | null;
|
|
665
|
+
/** P21 contract order limit */
|
|
666
|
+
contractOrderLimit: number | null;
|
|
667
|
+
/** P21 contract order limit used */
|
|
668
|
+
contractOrderLimitUsed: number | null;
|
|
669
|
+
/** Date the row was activated (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
670
|
+
activationDate: string | null;
|
|
671
|
+
/** Date the row expires (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
672
|
+
expirationDate: string | null;
|
|
673
|
+
/** P21 auto_assigned_flag (max 1 chars) */
|
|
674
|
+
autoAssignedFlag: string;
|
|
675
|
+
/** P21 exclude_from_freight_factor_flag (max 1 chars) */
|
|
676
|
+
excludeFromFreightFactorFlag: string;
|
|
677
|
+
/** P21 multiplier for the customer ship-to */
|
|
678
|
+
multiplier: number | null;
|
|
679
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
680
|
+
updateCd: number;
|
|
681
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
682
|
+
processCd: number;
|
|
683
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
684
|
+
statusCd: number;
|
|
685
|
+
[key: string]: unknown;
|
|
686
|
+
}
|
|
687
|
+
/** Returned by: api.pricing.jobPriceCustomerShipto.list(params) */
|
|
688
|
+
export type JobPriceCustomerShiptoListData = JobPriceCustomerShiptoListItem[];
|
|
689
|
+
/**
|
|
690
|
+
* Get Job Price Customer Ship-to Row
|
|
691
|
+
* Response data for GET /job-price-customer-shipto/{jobPriceCustShiptoUid} — MINIMUM fields, extras
|
|
692
|
+
* pass through
|
|
693
|
+
*
|
|
694
|
+
* Returned by: api.pricing.jobPriceCustomerShipto.get(jobPriceCustShiptoUid)
|
|
695
|
+
*/
|
|
696
|
+
export type JobPriceCustomerShiptoGetData = JobPriceCustomerShiptoListItem;
|
|
697
|
+
/**
|
|
698
|
+
* List Job Price Hdrs
|
|
699
|
+
* Response data for GET /job-price-hdr — MINIMUM fields, extras pass through
|
|
700
|
+
*
|
|
701
|
+
* Returned by: api.pricing.jobPriceHdr.list(params) (array items)
|
|
702
|
+
* Returned by: api.pricing.jobPriceHdr.get(jobPriceHdrUid)
|
|
703
|
+
*/
|
|
704
|
+
export interface JobPriceHdrListItem {
|
|
705
|
+
/** Job price (contract) header unique ID */
|
|
706
|
+
jobPriceHdrUid: number;
|
|
707
|
+
/** Job or contract number (max 8 chars) */
|
|
708
|
+
jobNo: string;
|
|
709
|
+
/** Job or contract description (max 255 chars) */
|
|
710
|
+
jobDescription: string | null;
|
|
711
|
+
/** Prophet 21 company the contract belongs to (max 8 chars) */
|
|
712
|
+
companyId: string;
|
|
713
|
+
/** Prophet 21 customer the contract prices for */
|
|
714
|
+
customerId: number | null;
|
|
715
|
+
/** Sales location of the contract */
|
|
716
|
+
salesLocId: number | null;
|
|
717
|
+
/** Contract number (max 255 chars) */
|
|
718
|
+
contractNo: string | null;
|
|
719
|
+
/** Customer contact on the contract (max 16 chars) */
|
|
720
|
+
contactId: string | null;
|
|
721
|
+
/** Date the contract starts pricing (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
722
|
+
startDate: string;
|
|
723
|
+
/** Date the contract stops pricing (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
724
|
+
endDate: string;
|
|
725
|
+
/** Ship-to the contract is limited to, when set */
|
|
726
|
+
shipToId: number | null;
|
|
727
|
+
/** Contract approved flag (Y or N) (max 1 chars) */
|
|
728
|
+
approved: string | null;
|
|
729
|
+
/** Contract cancelled flag (Y or N) (max 1 chars) */
|
|
730
|
+
cancelled: string | null;
|
|
731
|
+
/** User who entered the contract (max 30 chars) */
|
|
732
|
+
taker: string;
|
|
733
|
+
/** Customer purchase order number on the contract (max 50 chars) */
|
|
734
|
+
poNo: string | null;
|
|
735
|
+
/** Prophet 21 row status flag */
|
|
736
|
+
rowStatusFlag: number;
|
|
737
|
+
/** When the row was last changed (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
738
|
+
dateLastModified: string;
|
|
739
|
+
/** When the row was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
740
|
+
dateCreated: string;
|
|
741
|
+
/** User who last changed the row in Prophet 21 (max 30 chars) */
|
|
742
|
+
lastMaintainedBy: string;
|
|
743
|
+
/** Corporate address (customer parent) the contract applies to */
|
|
744
|
+
corpAddressId: number | null;
|
|
745
|
+
/** Salesrep on the contract (max 16 chars) */
|
|
746
|
+
salesrepId: string | null;
|
|
747
|
+
/** Currency line used for the contract */
|
|
748
|
+
currencyLineUid: number | null;
|
|
749
|
+
/** Currency conversion flag (Y or N) (max 1 chars) */
|
|
750
|
+
currencyConversion: string;
|
|
751
|
+
/** Consignment contract flag (Y or N) (max 1 chars) */
|
|
752
|
+
consignmentFlag: string;
|
|
753
|
+
/** Prophet 21 contract type code */
|
|
754
|
+
contractTypeCd: number;
|
|
755
|
+
/** Extended contract description (max 255 chars) */
|
|
756
|
+
extendedDesc: string | null;
|
|
757
|
+
/** Number of periods the contract runs */
|
|
758
|
+
noOfPeriods: number | null;
|
|
759
|
+
/** Canadian chargeback contract code */
|
|
760
|
+
cadChaContractCd: number | null;
|
|
761
|
+
/** Canadian chargeback supplier */
|
|
762
|
+
cadChaSupplierId: number | null;
|
|
763
|
+
/** Canadian chargeback quote number (max 255 chars) */
|
|
764
|
+
cadChaQuoteNo: string | null;
|
|
765
|
+
/** Canadian chargeback location */
|
|
766
|
+
cadChaLocationId: number | null;
|
|
767
|
+
/** Contract anniversary date (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
768
|
+
anniversaryDate: string | null;
|
|
769
|
+
/** Use totes flag (Y or N) (max 1 chars) */
|
|
770
|
+
useTotesFlag: string | null;
|
|
771
|
+
/** Added from a hand-held device flag (Y or N) (max 1 chars) */
|
|
772
|
+
handHeldAddFlag: string | null;
|
|
773
|
+
/** Update code */
|
|
774
|
+
updateCd: number;
|
|
775
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
776
|
+
processCd: number;
|
|
777
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
778
|
+
statusCd: number;
|
|
779
|
+
[key: string]: unknown;
|
|
780
|
+
}
|
|
781
|
+
/** Returned by: api.pricing.jobPriceHdr.list(params) */
|
|
782
|
+
export type JobPriceHdrListData = JobPriceHdrListItem[];
|
|
783
|
+
/**
|
|
784
|
+
* Get Job Price Header Details
|
|
785
|
+
* Response data for GET /job-price-hdr/{jobPriceHdrUid} — MINIMUM fields, extras pass through
|
|
786
|
+
*
|
|
787
|
+
* Returned by: api.pricing.jobPriceHdr.get(jobPriceHdrUid)
|
|
788
|
+
*/
|
|
789
|
+
export type JobPriceHdrGetData = JobPriceHdrListItem;
|
|
790
|
+
/**
|
|
791
|
+
* List Job Price Lines
|
|
792
|
+
* Response data for GET /job-price-hdr/{jobPriceHdrUid}/lines — MINIMUM fields, extras pass through
|
|
793
|
+
*
|
|
794
|
+
* Returned by: api.pricing.jobPriceHdr.lines.list(jobPriceHdrUid, params) (array items)
|
|
795
|
+
* Returned by: api.pricing.jobPriceHdr.lines.get(jobPriceHdrUid, jobPriceLineUid)
|
|
796
|
+
*/
|
|
797
|
+
export interface JobPriceHdrLinesListItem {
|
|
798
|
+
/** Job price (contract) line unique ID */
|
|
799
|
+
jobPriceLineUid: number;
|
|
800
|
+
/** Job price header the line belongs to */
|
|
801
|
+
jobPriceHdrUid: number;
|
|
802
|
+
/** Item the line prices */
|
|
803
|
+
invMastUid: number | null;
|
|
804
|
+
/** Unit of measure the price is for (max 8 chars) */
|
|
805
|
+
uom: string | null;
|
|
806
|
+
/** Number of base units in the unit of measure */
|
|
807
|
+
unitSize: number | null;
|
|
808
|
+
/** Prophet 21 pricing method code (how price is applied) */
|
|
809
|
+
pricingMethod: number | null;
|
|
810
|
+
/** Prophet 21 source price code (the base price a multiplier applies to) */
|
|
811
|
+
sourcePrice: number | null;
|
|
812
|
+
/** Contract price, or the value the pricing method applies */
|
|
813
|
+
price: number | null;
|
|
814
|
+
/** Quantity ordered against the contract line */
|
|
815
|
+
qtyOrdered: number | null;
|
|
816
|
+
/** Maximum quantity the contract line allows */
|
|
817
|
+
qtyMaximum: number | null;
|
|
818
|
+
/** Other cost type code */
|
|
819
|
+
otherCostTypeCd: number | null;
|
|
820
|
+
/** Other cost value */
|
|
821
|
+
otherCostValue: number | null;
|
|
822
|
+
/** Other cost source code */
|
|
823
|
+
otherCostSourceCd: number | null;
|
|
824
|
+
/** Other cost calculation method code */
|
|
825
|
+
otherCostCalcMethodCd: number | null;
|
|
826
|
+
/** Other cost calculation value */
|
|
827
|
+
otherCostCalcValue: number | null;
|
|
828
|
+
/** Commission cost type code */
|
|
829
|
+
commissionCostTypeCd: number | null;
|
|
830
|
+
/** Commission cost value */
|
|
831
|
+
commissionCostValue: number | null;
|
|
832
|
+
/** Commission cost source code */
|
|
833
|
+
commissionCostSourceCd: number | null;
|
|
834
|
+
/** Commission cost calculation method code */
|
|
835
|
+
commissionCostCalcMethodCd: number | null;
|
|
836
|
+
/** Commission cost calculation value */
|
|
837
|
+
commissionCostCalcValue: number | null;
|
|
838
|
+
/** Prophet 21 row status flag */
|
|
839
|
+
rowStatusFlag: number;
|
|
840
|
+
/** When the row was last changed (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
841
|
+
dateLastModified: string;
|
|
842
|
+
/** When the row was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
843
|
+
dateCreated: string;
|
|
844
|
+
/** User who last changed the row in Prophet 21 (max 30 chars) */
|
|
845
|
+
lastMaintainedBy: string;
|
|
846
|
+
/** Multiplier applied to the source price */
|
|
847
|
+
multiplier: number | null;
|
|
848
|
+
/** Line number within the contract */
|
|
849
|
+
lineNo: number;
|
|
850
|
+
/** Location the item is sourced from */
|
|
851
|
+
sourceLocationId: number | null;
|
|
852
|
+
/** Customer part number for the item (max 40 chars) */
|
|
853
|
+
customerPartNo: string | null;
|
|
854
|
+
/** Date the line stops pricing (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
855
|
+
expirationDate: string | null;
|
|
856
|
+
/** Vendor authorization number (max 255 chars) */
|
|
857
|
+
vendorAuthNo: string | null;
|
|
858
|
+
/** Purchase order cost */
|
|
859
|
+
poCost: number | null;
|
|
860
|
+
/** Currency of the line */
|
|
861
|
+
currencyId: number | null;
|
|
862
|
+
/** Discount group of the line (max 8 chars) */
|
|
863
|
+
discountGroupId: string | null;
|
|
864
|
+
/** Customer purchase order number (max 255 chars) */
|
|
865
|
+
custPoNo: string | null;
|
|
866
|
+
/** Item category the line applies to */
|
|
867
|
+
itemCategoryUid: number | null;
|
|
868
|
+
/** Item sub-category the line applies to */
|
|
869
|
+
subCategoryUid: number | null;
|
|
870
|
+
/** Product group the line applies to (max 8 chars) */
|
|
871
|
+
productGroupId: string | null;
|
|
872
|
+
/** Terminal ID */
|
|
873
|
+
terminalId: number | null;
|
|
874
|
+
/** Price page that supplies the line cost */
|
|
875
|
+
contractLineCostPageUid: number | null;
|
|
876
|
+
/** Price page that supplies the line price */
|
|
877
|
+
contractLinePricePageUid: number | null;
|
|
878
|
+
/** Budget code (max 255 chars) */
|
|
879
|
+
budgetCd: string | null;
|
|
880
|
+
/** Item revision the line applies to */
|
|
881
|
+
itemRevisionUid: number | null;
|
|
882
|
+
/** Date the line starts pricing (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
883
|
+
lineStartDate: string | null;
|
|
884
|
+
/** Initial commitment amount */
|
|
885
|
+
initialCommitmentAmount: number | null;
|
|
886
|
+
/** Commitment amount */
|
|
887
|
+
commitmentAmount: number | null;
|
|
888
|
+
/** Total commitment amount */
|
|
889
|
+
totalCommitmentAmount: number | null;
|
|
890
|
+
/** Pick fee */
|
|
891
|
+
pickFee: number | null;
|
|
892
|
+
/** Canadian purchase cost */
|
|
893
|
+
cadPurchaseCost: number | null;
|
|
894
|
+
/** Starting virtual inventory quantity */
|
|
895
|
+
startingVirtualInventoryQty: number | null;
|
|
896
|
+
/** Snapshot cost */
|
|
897
|
+
snapshotCost: number | null;
|
|
898
|
+
/** Minimum MCC code (max 255 chars) */
|
|
899
|
+
minimumMccCode: string | null;
|
|
900
|
+
/** Commission class (max 8 chars) */
|
|
901
|
+
commissionClassId: string | null;
|
|
902
|
+
/** Commission override percent */
|
|
903
|
+
commissionOverridePercent: number | null;
|
|
904
|
+
/** Update code */
|
|
905
|
+
updateCd: number;
|
|
906
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
907
|
+
processCd: number;
|
|
908
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
909
|
+
statusCd: number;
|
|
910
|
+
[key: string]: unknown;
|
|
911
|
+
}
|
|
912
|
+
/** Returned by: api.pricing.jobPriceHdr.lines.list(jobPriceHdrUid, params) */
|
|
913
|
+
export type JobPriceHdrLinesListData = JobPriceHdrLinesListItem[];
|
|
914
|
+
/**
|
|
915
|
+
* Get Job Price Line Details
|
|
916
|
+
* Response data for GET /job-price-hdr/{jobPriceHdrUid}/lines/{jobPriceLineUid} — MINIMUM fields,
|
|
917
|
+
* extras pass through
|
|
918
|
+
*
|
|
919
|
+
* Returned by: api.pricing.jobPriceHdr.lines.get(jobPriceHdrUid, jobPriceLineUid)
|
|
920
|
+
*/
|
|
921
|
+
export type JobPriceHdrLinesGetData = JobPriceHdrLinesListItem;
|
|
922
|
+
/**
|
|
923
|
+
* List Price Books
|
|
924
|
+
* Response data for GET /price-book — MINIMUM fields, extras pass through
|
|
925
|
+
*
|
|
926
|
+
* Returned by: api.pricing.priceBook.list(params) (array items)
|
|
927
|
+
* Returned by: api.pricing.priceBook.get(priceBookUid)
|
|
928
|
+
*/
|
|
929
|
+
export interface PriceBookListItem {
|
|
930
|
+
/** Price book ID */
|
|
931
|
+
priceBookUid: number;
|
|
932
|
+
/** P21 price book ID (max 20 chars) */
|
|
933
|
+
priceBookId: string;
|
|
934
|
+
/** Price book description (max 255 chars) */
|
|
935
|
+
description: string;
|
|
936
|
+
/** Row status from P21 (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
937
|
+
rowStatusFlag: number;
|
|
938
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
939
|
+
dateLastModified: string;
|
|
940
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
941
|
+
dateCreated: string;
|
|
942
|
+
/** P21 user who last changed the row (max 30 chars) */
|
|
943
|
+
lastMaintainedBy: string;
|
|
944
|
+
/** P21 user who created the row (max 255 chars) */
|
|
945
|
+
createdBy: string | null;
|
|
946
|
+
/** P21 company ID (max 255 chars) */
|
|
947
|
+
companyId: string | null;
|
|
948
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
949
|
+
updateCd: number;
|
|
950
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
951
|
+
processCd: number;
|
|
952
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
953
|
+
statusCd: number;
|
|
954
|
+
[key: string]: unknown;
|
|
955
|
+
}
|
|
956
|
+
/** Returned by: api.pricing.priceBook.list(params) */
|
|
957
|
+
export type PriceBookListData = PriceBookListItem[];
|
|
958
|
+
/**
|
|
959
|
+
* List Price Book To Library Links
|
|
960
|
+
* Response data for GET /price-book-x-library — MINIMUM fields, extras pass through
|
|
961
|
+
*
|
|
962
|
+
* Returned by: api.pricing.priceBookXLibrary.list(params) (array items)
|
|
963
|
+
* Returned by: api.pricing.priceBookXLibrary.get(priceBookXLibraryUid)
|
|
964
|
+
*/
|
|
965
|
+
export interface PriceBookXLibraryListItem {
|
|
966
|
+
/** Price book to library link ID (P21 price_book_x_library_uid) */
|
|
967
|
+
priceBookXLibraryUid: number;
|
|
968
|
+
/** Price library ID (price_library.price_library_uid) */
|
|
969
|
+
priceLibraryUid: number;
|
|
970
|
+
/** Price book ID (price_book.price_book_uid) */
|
|
971
|
+
priceBookUid: number;
|
|
972
|
+
/** Order of the book within the library (P21) */
|
|
973
|
+
sequenceNumber: number;
|
|
974
|
+
/** Row status from P21 (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
975
|
+
rowStatusFlag: number;
|
|
976
|
+
/** When the link last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
977
|
+
dateLastModified: string;
|
|
978
|
+
/** When the link was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
979
|
+
dateCreated: string;
|
|
980
|
+
/** P21 user who last changed the link (max 30 chars) */
|
|
981
|
+
lastMaintainedBy: string;
|
|
982
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
983
|
+
updateCd: number;
|
|
984
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
985
|
+
processCd: number;
|
|
986
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
987
|
+
statusCd: number;
|
|
988
|
+
[key: string]: unknown;
|
|
989
|
+
}
|
|
990
|
+
/** Returned by: api.pricing.priceBookXLibrary.list(params) */
|
|
991
|
+
export type PriceBookXLibraryListData = PriceBookXLibraryListItem[];
|
|
992
|
+
/**
|
|
993
|
+
* Get Price Book To Library Link
|
|
994
|
+
* Response data for GET /price-book-x-library/{priceBookXLibraryUid} — MINIMUM fields, extras pass
|
|
995
|
+
* through
|
|
996
|
+
*
|
|
997
|
+
* Returned by: api.pricing.priceBookXLibrary.get(priceBookXLibraryUid)
|
|
998
|
+
*/
|
|
999
|
+
export type PriceBookXLibraryGetData = PriceBookXLibraryListItem;
|
|
1000
|
+
/**
|
|
1001
|
+
* Get Price Book
|
|
1002
|
+
* Response data for GET /price-book/{priceBookUid} — MINIMUM fields, extras pass through
|
|
1003
|
+
*
|
|
1004
|
+
* Returned by: api.pricing.priceBook.get(priceBookUid)
|
|
1005
|
+
*/
|
|
1006
|
+
export type PriceBookGetData = PriceBookListItem;
|
|
1007
|
+
/**
|
|
1008
|
+
* Shape of `customer` (MINIMUM fields; reused wherever the same shape appears)
|
|
1009
|
+
* Customer pricing setup used by the engine
|
|
1010
|
+
*
|
|
1011
|
+
* Field `customer` of PriceEngineListData
|
|
1012
|
+
*/
|
|
1013
|
+
export interface PriceEngineListDataCustomer {
|
|
1014
|
+
/** P21 customer ID */
|
|
1015
|
+
customerId: number;
|
|
1016
|
+
/** True when the customer was found */
|
|
1017
|
+
valid: boolean;
|
|
1018
|
+
/** Customer's source price code, or false when none is set */
|
|
1019
|
+
sourcePriceCd: number | false;
|
|
1020
|
+
/** Description of the source price code */
|
|
1021
|
+
sourcePriceDesc: string | null;
|
|
1022
|
+
/** Customer's pricing method code (211 Multiplier, 234 Libraries) */
|
|
1023
|
+
pricingMethodCd: number | null;
|
|
1024
|
+
/** Description of the pricing method code */
|
|
1025
|
+
pricingMethodDesc: string | null;
|
|
1026
|
+
/** True when the customer has any active job pricing */
|
|
1027
|
+
hasJobPricing: boolean;
|
|
1028
|
+
/** True when job pricing is enabled for the customer */
|
|
1029
|
+
jobPricingEnabled: boolean;
|
|
1030
|
+
/** Corporate address ID used for corporate job pricing */
|
|
1031
|
+
corpAddressId: number | null;
|
|
1032
|
+
/** Number of jobs linked to the corporate address */
|
|
1033
|
+
corpAddressJobCount: number;
|
|
1034
|
+
/** Number of jobs linked to the customer or ship-to */
|
|
1035
|
+
customerShipToJobCount: number;
|
|
1036
|
+
[key: string]: unknown;
|
|
1037
|
+
}
|
|
1038
|
+
/**
|
|
1039
|
+
* Shape of `item` (MINIMUM fields; reused wherever the same shape appears)
|
|
1040
|
+
* Item, quantity, and unit of measure that were priced
|
|
1041
|
+
*
|
|
1042
|
+
* Field `item` of PriceEngineListData
|
|
1043
|
+
*/
|
|
1044
|
+
export interface PriceEngineListDataItem {
|
|
1045
|
+
/** P21 item ID */
|
|
1046
|
+
itemId: string;
|
|
1047
|
+
/** True when the item was found */
|
|
1048
|
+
valid: boolean;
|
|
1049
|
+
/** Inventory master UID when the item was found */
|
|
1050
|
+
invMastUid: number | null;
|
|
1051
|
+
/** Requested quantity */
|
|
1052
|
+
quantity: number;
|
|
1053
|
+
/** Unit of measure the price is expressed in */
|
|
1054
|
+
unitOfMeasure: string | null;
|
|
1055
|
+
[key: string]: unknown;
|
|
1056
|
+
}
|
|
1057
|
+
/**
|
|
1058
|
+
* Shape of `breaks` (MINIMUM fields; reused wherever the same shape appears)
|
|
1059
|
+
* Quantity break tiers of the matched page, lowest quantity first
|
|
1060
|
+
*
|
|
1061
|
+
* Field `breaks` of PriceEngineListDataLibraryPriceDataOption1
|
|
1062
|
+
*/
|
|
1063
|
+
export interface PriceEngineListDataLibraryPriceDataOption1BreaksItem {
|
|
1064
|
+
/** Page calculation value (multiplier or markup) for this tier */
|
|
1065
|
+
calculationValue: number | null;
|
|
1066
|
+
/** Quantity at which the next tier starts, or null for the last tier */
|
|
1067
|
+
break: number | null;
|
|
1068
|
+
/** First quantity this tier applies to */
|
|
1069
|
+
startQuantity: number;
|
|
1070
|
+
/** Last quantity this tier applies to, or null when open-ended */
|
|
1071
|
+
endQuantity: number | null;
|
|
1072
|
+
/** Unit price at this tier, or false when it could not be calculated */
|
|
1073
|
+
unitPrice: number | false;
|
|
1074
|
+
[key: string]: unknown;
|
|
1075
|
+
}
|
|
1076
|
+
/**
|
|
1077
|
+
* Shape of `libraryPriceData` (MINIMUM fields; reused wherever the same shape appears)
|
|
1078
|
+
* Library pricing detail whenever the library stage ran, including when it found no price
|
|
1079
|
+
*
|
|
1080
|
+
* Field `libraryPriceData` of PriceEngineListData
|
|
1081
|
+
*/
|
|
1082
|
+
export interface PriceEngineListDataLibraryPriceDataOption1 {
|
|
1083
|
+
/** Unit price in the requested unit of measure, or false when no page produced a price */
|
|
1084
|
+
unitPrice: number | false;
|
|
1085
|
+
/** Source price the page calculation started from */
|
|
1086
|
+
sourcePrice: number | null | false;
|
|
1087
|
+
/** Quantity used to select the break tier */
|
|
1088
|
+
quantity: number;
|
|
1089
|
+
/** Price page UID that matched */
|
|
1090
|
+
pricePageUid: number;
|
|
1091
|
+
/** Description of the matched price page */
|
|
1092
|
+
pricePageDescription: string;
|
|
1093
|
+
/** Page type code that decided the match (212 item to 2339 price family) */
|
|
1094
|
+
pricePageCdType: number;
|
|
1095
|
+
/** Description of the page type code */
|
|
1096
|
+
pricePageCdDesc: string;
|
|
1097
|
+
/** Date the matched page takes effect */
|
|
1098
|
+
effectiveDate: string;
|
|
1099
|
+
/** Date the matched page expires */
|
|
1100
|
+
expirationDate: string;
|
|
1101
|
+
/** P21 item ID */
|
|
1102
|
+
itemId: string;
|
|
1103
|
+
/** Inventory master UID */
|
|
1104
|
+
invMastUid: number;
|
|
1105
|
+
/** Page pricing method code */
|
|
1106
|
+
pricingMethodCd: number;
|
|
1107
|
+
/** Description of the pricing method code */
|
|
1108
|
+
pricingMethodCdDesc: string;
|
|
1109
|
+
/** Source price code the source price came from */
|
|
1110
|
+
sourcePriceCd: number;
|
|
1111
|
+
/** Description of the source price code */
|
|
1112
|
+
sourcePriceCdDesc: string;
|
|
1113
|
+
/** Calculation method code (211 multiplier, 229 markup, 1292 fixed price) */
|
|
1114
|
+
calculationMethodCd: number;
|
|
1115
|
+
/** Description of the calculation method code */
|
|
1116
|
+
calculationMethodCdDesc: string;
|
|
1117
|
+
/** Totaling method code */
|
|
1118
|
+
totalingMethodCd: number;
|
|
1119
|
+
/** Description of the totaling method code */
|
|
1120
|
+
totalingMethodCdDesc: string;
|
|
1121
|
+
/** Page calculator type: P price, B break, C cost */
|
|
1122
|
+
calculatorType: string;
|
|
1123
|
+
/** Item's purchase pricing unit */
|
|
1124
|
+
purchasePricingUnit: string | null;
|
|
1125
|
+
/** Size of the purchase pricing unit */
|
|
1126
|
+
purchasePricingUnitSize: number | null;
|
|
1127
|
+
/** Item's sales pricing unit */
|
|
1128
|
+
salesPricingUnit: string | null;
|
|
1129
|
+
/** Size of the sales pricing unit */
|
|
1130
|
+
salesPricingUnitSize: number | null;
|
|
1131
|
+
/** Unit of measure the price is expressed in */
|
|
1132
|
+
unitOfMeasure: string | null;
|
|
1133
|
+
/** Size of the unit of measure in base units */
|
|
1134
|
+
unitOfMeasureSize: number | null;
|
|
1135
|
+
/** Item's default selling unit */
|
|
1136
|
+
defaultSellingUnit: string | null;
|
|
1137
|
+
/** Size of the default selling unit */
|
|
1138
|
+
defaultSellingUnitSize: number | null;
|
|
1139
|
+
/** Item's default purchasing unit */
|
|
1140
|
+
defaultPurchasingUnit: string | null;
|
|
1141
|
+
/** Size of the default purchasing unit */
|
|
1142
|
+
defaultPurchasingUnitSize: number | null;
|
|
1143
|
+
/** Item's base unit */
|
|
1144
|
+
baseUnit: string | null;
|
|
1145
|
+
/** Size of the base unit */
|
|
1146
|
+
baseUnitSize: number | null;
|
|
1147
|
+
/** Calculation value applied for the quantity (multiplier or markup percent) */
|
|
1148
|
+
multiplier: number;
|
|
1149
|
+
/** Quantity break tiers of the matched page, lowest quantity first */
|
|
1150
|
+
breaks: PriceEngineListDataLibraryPriceDataOption1BreaksItem[];
|
|
1151
|
+
/** Base size the source price is divided by, set when the calculation runs */
|
|
1152
|
+
baseSize: number | null;
|
|
1153
|
+
/** Price per base unit, set when the calculation runs */
|
|
1154
|
+
basePrice: number | null;
|
|
1155
|
+
/** Candidate cost value on the cost path, committed as source price only after a page match */
|
|
1156
|
+
potentialCostValue: number | null;
|
|
1157
|
+
/** Cost page UID used on the cost path */
|
|
1158
|
+
costPageUid: number | null;
|
|
1159
|
+
/** Description of the cost page */
|
|
1160
|
+
costPageDescription: string | null;
|
|
1161
|
+
/** True when a cost page matched on the cost path */
|
|
1162
|
+
costPageMatched: boolean | null;
|
|
1163
|
+
/** Where the cost came from when a fallback was used */
|
|
1164
|
+
costSource: string | null;
|
|
1165
|
+
/** Supplier ID whose last received PO cost was used (source code 204) */
|
|
1166
|
+
lastReceivedPoCostSupplierId: number | null;
|
|
1167
|
+
/** Item's product group at the pricing location */
|
|
1168
|
+
invLocProductGroupId: string | null;
|
|
1169
|
+
/** Product group on the matched page */
|
|
1170
|
+
pricePageProductGroupId: string | null;
|
|
1171
|
+
/** Supplier ID on the matched page */
|
|
1172
|
+
pricePageSupplierId: number | null;
|
|
1173
|
+
/** Discount group on the matched page */
|
|
1174
|
+
pricePageDiscountGroupId: string | null;
|
|
1175
|
+
/** Manufacturer class on the matched page */
|
|
1176
|
+
pricePageMfgClassId: string | null;
|
|
1177
|
+
/** Price family UID on the matched page */
|
|
1178
|
+
pricePagePriceFamilyUid: number | null;
|
|
1179
|
+
/** Item's sales discount group at the pricing location */
|
|
1180
|
+
invLocSalesDiscountGroup: string | null;
|
|
1181
|
+
/** Item's price family UID at the pricing location */
|
|
1182
|
+
invLocPriceFamilyUid: number | null;
|
|
1183
|
+
[key: string]: unknown;
|
|
1184
|
+
}
|
|
1185
|
+
/**
|
|
1186
|
+
* Shape of `libraryPriceData` (MINIMUM fields; reused wherever the same shape appears)
|
|
1187
|
+
* Library pricing detail whenever the library stage ran, including when it found no price
|
|
1188
|
+
*
|
|
1189
|
+
* Field `libraryPriceData` of PriceEngineListData
|
|
1190
|
+
*/
|
|
1191
|
+
export interface PriceEngineListDataLibraryPriceDataOption2 {
|
|
1192
|
+
/** Unit price, or false when the library produced no price */
|
|
1193
|
+
unitPrice: number | false;
|
|
1194
|
+
/** Pricing source label, libraryMultiplier when a price was found */
|
|
1195
|
+
pricedFrom: string | null;
|
|
1196
|
+
/** Source price the multiplier was applied to */
|
|
1197
|
+
sourcePrice: number | null;
|
|
1198
|
+
/** Source price code the source price came from */
|
|
1199
|
+
sourcePriceCd: number | null;
|
|
1200
|
+
/** Library multiplier applied to the source price */
|
|
1201
|
+
multiplier: number | null;
|
|
1202
|
+
/** Price library UID that produced the price */
|
|
1203
|
+
priceLibraryUid: number | null;
|
|
1204
|
+
/** Unit of measure size applied to the base price */
|
|
1205
|
+
unitOfMeasureSize: number | null;
|
|
1206
|
+
[key: string]: unknown;
|
|
1207
|
+
}
|
|
1208
|
+
/**
|
|
1209
|
+
* Shape of `defaultCompanyPrice` (MINIMUM fields; reused wherever the same shape appears)
|
|
1210
|
+
* Default company pricing detail when that stage ran
|
|
1211
|
+
*
|
|
1212
|
+
* Field `defaultCompanyPrice` of PriceEngineListData
|
|
1213
|
+
*/
|
|
1214
|
+
export interface PriceEngineListDataDefaultCompanyPrice {
|
|
1215
|
+
/** Unit price in the requested unit of measure, or false when none was found */
|
|
1216
|
+
unitPrice: number | false;
|
|
1217
|
+
/** Item's purchase pricing unit size from inv_mast */
|
|
1218
|
+
purchasePricingUnitSize: number | null;
|
|
1219
|
+
/** Company price source code (PRICE_1 to PRICE_10 or supplier list price), 0 when none */
|
|
1220
|
+
sourceTypeCd: number;
|
|
1221
|
+
/** Description of the company price source code */
|
|
1222
|
+
sourceTypeDesc: string | null;
|
|
1223
|
+
/** Unit of measure the price is expressed in */
|
|
1224
|
+
unitOfMeasure: string;
|
|
1225
|
+
/** Size of the unit of measure in base units */
|
|
1226
|
+
unitOfMeasureSize: number;
|
|
1227
|
+
/** Source price before base size and unit of measure conversion */
|
|
1228
|
+
basePrice: number;
|
|
1229
|
+
/** Base size the source price is divided by */
|
|
1230
|
+
baseSize: number;
|
|
1231
|
+
[key: string]: unknown;
|
|
1232
|
+
}
|
|
1233
|
+
/**
|
|
1234
|
+
* Get Item Price
|
|
1235
|
+
* Response data for GET /price-engine — MINIMUM fields, extras pass through
|
|
1236
|
+
*
|
|
1237
|
+
* Returned by: api.pricing.priceEngine.list(params)
|
|
1238
|
+
* Field `priceEngine` of PriceEngineCreateDataItemsItem
|
|
1239
|
+
*/
|
|
1240
|
+
export interface PriceEngineListData {
|
|
1241
|
+
/** Selling price per unit of measure; 0 when no stage produced a price */
|
|
1242
|
+
unitPrice: number;
|
|
1243
|
+
/** Waterfall stage that produced the price, or false when none did */
|
|
1244
|
+
pricedFrom: "jobPricing" | "sourceCd" | "libraryPrice" | "libraryMultiplier" | "defaultCompanyPrice" | false;
|
|
1245
|
+
/** Short code of the winning stage (J, S, L, C), or false when none did */
|
|
1246
|
+
priceType: "J" | "S" | "L" | "C" | false;
|
|
1247
|
+
/** Job or contract price when job pricing matched, otherwise false */
|
|
1248
|
+
jobPrice: number | false;
|
|
1249
|
+
/** Primary supplier list price, always calculated for reference */
|
|
1250
|
+
listPrice: number;
|
|
1251
|
+
/** Customer pricing setup used by the engine */
|
|
1252
|
+
customer: PriceEngineListDataCustomer;
|
|
1253
|
+
/** Item, quantity, and unit of measure that were priced */
|
|
1254
|
+
item: PriceEngineListDataItem;
|
|
1255
|
+
/**
|
|
1256
|
+
* Input options the engine ran with, keyed by option name (customerId, itemId, quantity,
|
|
1257
|
+
* unitOfMeasure, shipToId, cartItems) ([] when empty)
|
|
1258
|
+
*/
|
|
1259
|
+
options: Record<string, unknown> | [];
|
|
1260
|
+
/** Diagnostic messages collected while pricing */
|
|
1261
|
+
messages: string[];
|
|
1262
|
+
/** Job number when job pricing matched */
|
|
1263
|
+
jobNo: string | null;
|
|
1264
|
+
/** Job price header UID when job pricing matched */
|
|
1265
|
+
jobPriceHdrUid: number | null;
|
|
1266
|
+
/** Contract number when job pricing matched */
|
|
1267
|
+
contractNo: string | null;
|
|
1268
|
+
/** Library pricing detail whenever the library stage ran, including when it found no price */
|
|
1269
|
+
libraryPriceData: PriceEngineListDataLibraryPriceDataOption1 | PriceEngineListDataLibraryPriceDataOption2 | null;
|
|
1270
|
+
/** Default company pricing detail when that stage ran */
|
|
1271
|
+
defaultCompanyPrice: PriceEngineListDataDefaultCompanyPrice | null;
|
|
1272
|
+
/** Web discount price for the customer, or false when no web pricing rule applies */
|
|
1273
|
+
webPrice: number | false;
|
|
1274
|
+
[key: string]: unknown;
|
|
1275
|
+
}
|
|
1276
|
+
/**
|
|
1277
|
+
* Shape of `items` (MINIMUM fields; reused wherever the same shape appears)
|
|
1278
|
+
* Price for each cart line
|
|
1279
|
+
*
|
|
1280
|
+
* Field `items` of PriceEngineCreateData
|
|
1281
|
+
*/
|
|
1282
|
+
export interface PriceEngineCreateDataItemsItem {
|
|
1283
|
+
/** P21 item ID */
|
|
1284
|
+
itemId: string;
|
|
1285
|
+
/** Quantity priced */
|
|
1286
|
+
quantity: number;
|
|
1287
|
+
/**
|
|
1288
|
+
* Unit of measure the price is expressed in; empty when neither the request nor the item supplied
|
|
1289
|
+
* one
|
|
1290
|
+
*/
|
|
1291
|
+
unitOfMeasure: string;
|
|
1292
|
+
/** Full price engine result for this line */
|
|
1293
|
+
priceEngine: PriceEngineListData;
|
|
1294
|
+
[key: string]: unknown;
|
|
1295
|
+
}
|
|
1296
|
+
/**
|
|
1297
|
+
* Cart Price Engine
|
|
1298
|
+
* Response data for POST /price-engine — MINIMUM fields, extras pass through
|
|
1299
|
+
*
|
|
1300
|
+
* Returned by: api.pricing.priceEngine.create(data)
|
|
1301
|
+
*/
|
|
1302
|
+
export interface PriceEngineCreateData {
|
|
1303
|
+
/** P21 customer ID the cart was priced for */
|
|
1304
|
+
customerId: number;
|
|
1305
|
+
/** Ship-to ID used for pricing */
|
|
1306
|
+
shipToId: number;
|
|
1307
|
+
/** Number of cart lines priced */
|
|
1308
|
+
itemCount: number;
|
|
1309
|
+
/** Price for each cart line */
|
|
1310
|
+
items: PriceEngineCreateDataItemsItem[];
|
|
1311
|
+
[key: string]: unknown;
|
|
1312
|
+
}
|
|
1313
|
+
/**
|
|
1314
|
+
* Shape of `items` (MINIMUM fields; reused wherever the same shape appears)
|
|
1315
|
+
* Cart lines to price; MUST NOT be empty
|
|
1316
|
+
*
|
|
1317
|
+
* Field `items` of PriceEngineCreateBody
|
|
1318
|
+
*/
|
|
1319
|
+
export interface PriceEngineCreateBodyItemsItem {
|
|
1320
|
+
/** P21 item ID; lines with an empty itemId are skipped */
|
|
1321
|
+
itemId: string;
|
|
1322
|
+
/** Quantity to price, defaults to 1 */
|
|
1323
|
+
quantity?: number;
|
|
1324
|
+
/** Unit of measure to price in; the item's default when omitted */
|
|
1325
|
+
unitOfMeasure?: string | null;
|
|
1326
|
+
[key: string]: unknown;
|
|
1327
|
+
}
|
|
1328
|
+
/**
|
|
1329
|
+
* Cart Price Engine
|
|
1330
|
+
* Request body for POST /price-engine — MINIMUM fields, extras pass through
|
|
1331
|
+
*
|
|
1332
|
+
* Request body of: api.pricing.priceEngine.create(data)
|
|
1333
|
+
*/
|
|
1334
|
+
export interface PriceEngineCreateBody {
|
|
1335
|
+
/** P21 customer ID to price for; MUST be positive */
|
|
1336
|
+
customerId: number;
|
|
1337
|
+
/** Cart lines to price; MUST NOT be empty */
|
|
1338
|
+
items: PriceEngineCreateBodyItemsItem[];
|
|
1339
|
+
/** Ship-to ID for location-based pricing; defaults to customerId */
|
|
1340
|
+
shipToId?: number | null;
|
|
1341
|
+
[key: string]: unknown;
|
|
1342
|
+
}
|
|
1343
|
+
/**
|
|
1344
|
+
* List Price Families
|
|
1345
|
+
* Response data for GET /price-family — MINIMUM fields, extras pass through
|
|
1346
|
+
*
|
|
1347
|
+
* Returned by: api.pricing.priceFamily.list(params) (array items)
|
|
1348
|
+
* Returned by: api.pricing.priceFamily.get(priceFamilyUid)
|
|
1349
|
+
*/
|
|
1350
|
+
export interface PriceFamilyListItem {
|
|
1351
|
+
/** P21 price family ID (max 255 chars) */
|
|
1352
|
+
priceFamilyId: string;
|
|
1353
|
+
/** Price family description (max 255 chars) */
|
|
1354
|
+
priceFamilyDesc: string;
|
|
1355
|
+
/** Row status from P21 (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1356
|
+
rowStatusFlag: number;
|
|
1357
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1358
|
+
dateCreated: string;
|
|
1359
|
+
/** P21 user who created the row (max 255 chars) */
|
|
1360
|
+
createdBy: string;
|
|
1361
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1362
|
+
dateLastModified: string;
|
|
1363
|
+
/** P21 user who last changed the row (max 255 chars) */
|
|
1364
|
+
lastMaintainedBy: string;
|
|
1365
|
+
/** Price family ID (price_family.price_family_uid) */
|
|
1366
|
+
priceFamilyUid: number;
|
|
1367
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
1368
|
+
updateCd: number;
|
|
1369
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
1370
|
+
processCd: number;
|
|
1371
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1372
|
+
statusCd: number;
|
|
1373
|
+
[key: string]: unknown;
|
|
1374
|
+
}
|
|
1375
|
+
/** Returned by: api.pricing.priceFamily.list(params) */
|
|
1376
|
+
export type PriceFamilyListData = PriceFamilyListItem[];
|
|
1377
|
+
/**
|
|
1378
|
+
* List Price Family To Restricted Class Links
|
|
1379
|
+
* Response data for GET /price-family-x-restricted-class — MINIMUM fields, extras pass through
|
|
1380
|
+
*
|
|
1381
|
+
* Returned by: api.pricing.priceFamilyXRestrictedClass.list(params) (array items)
|
|
1382
|
+
* Returned by: api.pricing.priceFamilyXRestrictedClass.get(priceFamilyXRestrictedClassUid)
|
|
1383
|
+
*/
|
|
1384
|
+
export interface PriceFamilyXRestrictedClassListItem {
|
|
1385
|
+
/** Price family to restricted class link ID */
|
|
1386
|
+
priceFamilyXRestrictedClassUid: number;
|
|
1387
|
+
/** Price family ID (price_family.price_family_uid) */
|
|
1388
|
+
priceFamilyUid: number;
|
|
1389
|
+
/** P21 restricted class ID */
|
|
1390
|
+
restrictedClassUid: number;
|
|
1391
|
+
/** Row status from P21 (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1392
|
+
rowStatusFlag: number;
|
|
1393
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1394
|
+
dateCreated: string;
|
|
1395
|
+
/** P21 user who created the row (max 255 chars) */
|
|
1396
|
+
createdBy: string;
|
|
1397
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1398
|
+
dateLastModified: string;
|
|
1399
|
+
/** P21 user who last changed the row (max 255 chars) */
|
|
1400
|
+
lastMaintainedBy: string;
|
|
1401
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
1402
|
+
updateCd: number;
|
|
1403
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
1404
|
+
processCd: number;
|
|
1405
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1406
|
+
statusCd: number;
|
|
1407
|
+
[key: string]: unknown;
|
|
1408
|
+
}
|
|
1409
|
+
/** Returned by: api.pricing.priceFamilyXRestrictedClass.list(params) */
|
|
1410
|
+
export type PriceFamilyXRestrictedClassListData = PriceFamilyXRestrictedClassListItem[];
|
|
1411
|
+
/**
|
|
1412
|
+
* Get Price Family To Restricted Class Link
|
|
1413
|
+
* Response data for GET /price-family-x-restricted-class/{priceFamilyXRestrictedClassUid} — MINIMUM
|
|
1414
|
+
* fields, extras pass through
|
|
1415
|
+
*
|
|
1416
|
+
* Returned by: api.pricing.priceFamilyXRestrictedClass.get(priceFamilyXRestrictedClassUid)
|
|
1417
|
+
*/
|
|
1418
|
+
export type PriceFamilyXRestrictedClassGetData = PriceFamilyXRestrictedClassListItem;
|
|
1419
|
+
/**
|
|
1420
|
+
* Get Price Family
|
|
1421
|
+
* Response data for GET /price-family/{priceFamilyUid} — MINIMUM fields, extras pass through
|
|
1422
|
+
*
|
|
1423
|
+
* Returned by: api.pricing.priceFamily.get(priceFamilyUid)
|
|
1424
|
+
*/
|
|
1425
|
+
export type PriceFamilyGetData = PriceFamilyListItem;
|
|
1426
|
+
/**
|
|
1427
|
+
* List Price Libraries
|
|
1428
|
+
* Response data for GET /price-library — MINIMUM fields, extras pass through
|
|
1429
|
+
*
|
|
1430
|
+
* Returned by: api.pricing.priceLibrary.list(params) (array items)
|
|
1431
|
+
* Returned by: api.pricing.priceLibrary.get(priceLibraryUid)
|
|
1432
|
+
*/
|
|
1433
|
+
export interface PriceLibraryListItem {
|
|
1434
|
+
/** Price library ID */
|
|
1435
|
+
priceLibraryUid: number;
|
|
1436
|
+
/** P21 price library ID (max 20 chars) */
|
|
1437
|
+
priceLibraryId: string;
|
|
1438
|
+
/** Price library description (max 255 chars) */
|
|
1439
|
+
description: string;
|
|
1440
|
+
/** P21 price library category code */
|
|
1441
|
+
categoryCd: number;
|
|
1442
|
+
/** P21 price library type code */
|
|
1443
|
+
typeCd: number;
|
|
1444
|
+
/** P21 source price code for the price library */
|
|
1445
|
+
sourcePriceCd: number | null;
|
|
1446
|
+
/** P21 price library multiplier */
|
|
1447
|
+
multiplier: number | null;
|
|
1448
|
+
/** Row status from P21 (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1449
|
+
rowStatusFlag: number;
|
|
1450
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1451
|
+
dateLastModified: string;
|
|
1452
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1453
|
+
dateCreated: string;
|
|
1454
|
+
/** P21 user who last changed the row (max 30 chars) */
|
|
1455
|
+
lastMaintainedBy: string;
|
|
1456
|
+
/** P21 user who created the row (max 255 chars) */
|
|
1457
|
+
createdBy: string | null;
|
|
1458
|
+
/** P21 terminal ID */
|
|
1459
|
+
terminalId: number | null;
|
|
1460
|
+
/** P21 company ID (max 255 chars) */
|
|
1461
|
+
companyId: string | null;
|
|
1462
|
+
/** P21 strategic_price_library_flag on the price library (max 1 chars) */
|
|
1463
|
+
strategicPriceLibraryFlag: string;
|
|
1464
|
+
/** P21 customer size code */
|
|
1465
|
+
customerSizeCd: number | null;
|
|
1466
|
+
/** P21 customer category ID */
|
|
1467
|
+
customerCategoryUid: number | null;
|
|
1468
|
+
/** P21 library_on_contract on the price library (max 1 chars) */
|
|
1469
|
+
libraryOnContract: string;
|
|
1470
|
+
/** P21 exclude_from_cust_multiplier_flag on the price library (max 1 chars) */
|
|
1471
|
+
excludeFromCustMultiplierFlag: string | null;
|
|
1472
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
1473
|
+
updateCd: number;
|
|
1474
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
1475
|
+
processCd: number;
|
|
1476
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1477
|
+
statusCd: number;
|
|
1478
|
+
[key: string]: unknown;
|
|
1479
|
+
}
|
|
1480
|
+
/** Returned by: api.pricing.priceLibrary.list(params) */
|
|
1481
|
+
export type PriceLibraryListData = PriceLibraryListItem[];
|
|
1482
|
+
/**
|
|
1483
|
+
* List Price Library To Customer Links
|
|
1484
|
+
* Response data for GET /price-library-x-cust-x-cmpy — MINIMUM fields, extras pass through
|
|
1485
|
+
*
|
|
1486
|
+
* Returned by: api.pricing.priceLibraryXCustXCmpy.list(params) (array items)
|
|
1487
|
+
* Returned by: api.pricing.priceLibraryXCustXCmpy.get(priceLibXCustXCmpyUid)
|
|
1488
|
+
*/
|
|
1489
|
+
export interface PriceLibraryXCustXCmpyListItem {
|
|
1490
|
+
/** Price library to customer link ID (P21 price_lib_x_cust_x_cmpy_uid) */
|
|
1491
|
+
priceLibXCustXCmpyUid: number;
|
|
1492
|
+
/** P21 company ID (max 8 chars) */
|
|
1493
|
+
companyId: string;
|
|
1494
|
+
/** P21 customer ID (customer.customer_id) */
|
|
1495
|
+
customerId: number;
|
|
1496
|
+
/** Price library ID (price_library.price_library_uid) */
|
|
1497
|
+
priceLibraryUid: number;
|
|
1498
|
+
/** Order in which the price engine walks this library for the customer (P21) */
|
|
1499
|
+
sequenceNumber: number;
|
|
1500
|
+
/** Row status from P21 (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1501
|
+
rowStatusFlag: number;
|
|
1502
|
+
/** When the link last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1503
|
+
dateLastModified: string;
|
|
1504
|
+
/** When the link was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1505
|
+
dateCreated: string;
|
|
1506
|
+
/** P21 user who last changed the link (max 30 chars) */
|
|
1507
|
+
lastMaintainedBy: string;
|
|
1508
|
+
/**
|
|
1509
|
+
* P21 web_based_pricing flag (Y/N) on the customer library link; part of the unique key with
|
|
1510
|
+
* company, customer and sequence (max 1 chars)
|
|
1511
|
+
*/
|
|
1512
|
+
webBasedPricing: string;
|
|
1513
|
+
/** P21 distributor_net_flag (Y/N) on the customer library link (max 1 chars) */
|
|
1514
|
+
distributorNetFlag: string;
|
|
1515
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
1516
|
+
updateCd: number;
|
|
1517
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
1518
|
+
processCd: number;
|
|
1519
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1520
|
+
statusCd: number;
|
|
1521
|
+
[key: string]: unknown;
|
|
1522
|
+
}
|
|
1523
|
+
/** Returned by: api.pricing.priceLibraryXCustXCmpy.list(params) */
|
|
1524
|
+
export type PriceLibraryXCustXCmpyListData = PriceLibraryXCustXCmpyListItem[];
|
|
1525
|
+
/**
|
|
1526
|
+
* Get Price Library To Customer Link
|
|
1527
|
+
* Response data for GET /price-library-x-cust-x-cmpy/{priceLibXCustXCmpyUid} — MINIMUM fields,
|
|
1528
|
+
* extras pass through
|
|
1529
|
+
*
|
|
1530
|
+
* Returned by: api.pricing.priceLibraryXCustXCmpy.get(priceLibXCustXCmpyUid)
|
|
1531
|
+
*/
|
|
1532
|
+
export type PriceLibraryXCustXCmpyGetData = PriceLibraryXCustXCmpyListItem;
|
|
1533
|
+
/**
|
|
1534
|
+
* List Price Library To Ship-to Links
|
|
1535
|
+
* Response data for GET /price-library-x-ship-to — MINIMUM fields, extras pass through
|
|
1536
|
+
*
|
|
1537
|
+
* Returned by: api.pricing.priceLibraryXShipTo.list(params) (array items)
|
|
1538
|
+
* Returned by: api.pricing.priceLibraryXShipTo.get(priceLibraryXShipToUid)
|
|
1539
|
+
*/
|
|
1540
|
+
export interface PriceLibraryXShipToListItem {
|
|
1541
|
+
/** Price library to ship-to link ID (P21 price_library_x_ship_to_uid) */
|
|
1542
|
+
priceLibraryXShipToUid: number;
|
|
1543
|
+
/** Price library ID (price_library.price_library_uid) */
|
|
1544
|
+
priceLibraryUid: number;
|
|
1545
|
+
/** P21 company ID (max 8 chars) */
|
|
1546
|
+
companyId: string;
|
|
1547
|
+
/** P21 ship-to ID (ship_to.ship_to_id) */
|
|
1548
|
+
shipToId: number;
|
|
1549
|
+
/** Order in which the price engine walks this library for the ship-to (P21) */
|
|
1550
|
+
sequenceNumber: number;
|
|
1551
|
+
/** Row status from P21 (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1552
|
+
rowStatusFlag: number;
|
|
1553
|
+
/** When the link was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1554
|
+
dateCreated: string;
|
|
1555
|
+
/** P21 user who created the link (max 255 chars) */
|
|
1556
|
+
createdBy: string;
|
|
1557
|
+
/** When the link last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1558
|
+
dateLastModified: string;
|
|
1559
|
+
/** P21 user who last changed the link (max 255 chars) */
|
|
1560
|
+
lastMaintainedBy: string;
|
|
1561
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
1562
|
+
updateCd: number;
|
|
1563
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
1564
|
+
processCd: number;
|
|
1565
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1566
|
+
statusCd: number;
|
|
1567
|
+
[key: string]: unknown;
|
|
1568
|
+
}
|
|
1569
|
+
/** Returned by: api.pricing.priceLibraryXShipTo.list(params) */
|
|
1570
|
+
export type PriceLibraryXShipToListData = PriceLibraryXShipToListItem[];
|
|
1571
|
+
/**
|
|
1572
|
+
* Get Price Library To Ship-to Link
|
|
1573
|
+
* Response data for GET /price-library-x-ship-to/{priceLibraryXShipToUid} — MINIMUM fields, extras
|
|
1574
|
+
* pass through
|
|
1575
|
+
*
|
|
1576
|
+
* Returned by: api.pricing.priceLibraryXShipTo.get(priceLibraryXShipToUid)
|
|
1577
|
+
*/
|
|
1578
|
+
export type PriceLibraryXShipToGetData = PriceLibraryXShipToListItem;
|
|
1579
|
+
/**
|
|
1580
|
+
* Get Price Library
|
|
1581
|
+
* Response data for GET /price-library/{priceLibraryUid} — MINIMUM fields, extras pass through
|
|
1582
|
+
*
|
|
1583
|
+
* Returned by: api.pricing.priceLibrary.get(priceLibraryUid)
|
|
1584
|
+
*/
|
|
1585
|
+
export type PriceLibraryGetData = PriceLibraryListItem;
|
|
1586
|
+
/**
|
|
1587
|
+
* List Price Method To Customer Links
|
|
1588
|
+
* Response data for GET /price-method-x-customer — MINIMUM fields, extras pass through
|
|
1589
|
+
*
|
|
1590
|
+
* Returned by: api.pricing.priceMethodXCustomer.list(params) (array items)
|
|
1591
|
+
* Returned by: api.pricing.priceMethodXCustomer.get(priceMethodXCustomerUid)
|
|
1592
|
+
*/
|
|
1593
|
+
export interface PriceMethodXCustomerListItem {
|
|
1594
|
+
/** Price method to customer link ID */
|
|
1595
|
+
priceMethodXCustomerUid: number;
|
|
1596
|
+
/** P21 price method ID */
|
|
1597
|
+
priceMethodUid: number;
|
|
1598
|
+
/** P21 company ID (max 8 chars) */
|
|
1599
|
+
companyId: string;
|
|
1600
|
+
/** P21 customer ID (customer.customer_id) */
|
|
1601
|
+
customerId: number | null;
|
|
1602
|
+
/** P21 ship-to ID (ship_to.ship_to_id) */
|
|
1603
|
+
shipToId: number | null;
|
|
1604
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
1605
|
+
updateCd: number;
|
|
1606
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
1607
|
+
processCd: number;
|
|
1608
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1609
|
+
statusCd: number;
|
|
1610
|
+
[key: string]: unknown;
|
|
1611
|
+
}
|
|
1612
|
+
/** Returned by: api.pricing.priceMethodXCustomer.list(params) */
|
|
1613
|
+
export type PriceMethodXCustomerListData = PriceMethodXCustomerListItem[];
|
|
1614
|
+
/**
|
|
1615
|
+
* Get Price Method To Customer Link
|
|
1616
|
+
* Response data for GET /price-method-x-customer/{priceMethodXCustomerUid} — MINIMUM fields, extras
|
|
1617
|
+
* pass through
|
|
1618
|
+
*
|
|
1619
|
+
* Returned by: api.pricing.priceMethodXCustomer.get(priceMethodXCustomerUid)
|
|
1620
|
+
*/
|
|
1621
|
+
export type PriceMethodXCustomerGetData = PriceMethodXCustomerListItem;
|
|
1622
|
+
/**
|
|
1623
|
+
* List Price Pages
|
|
1624
|
+
* Response data for GET /price-page — MINIMUM fields, extras pass through
|
|
1625
|
+
*
|
|
1626
|
+
* Returned by: api.pricing.pricePage.list(params) (array items)
|
|
1627
|
+
* Returned by: api.pricing.pricePage.get(pricePageUid)
|
|
1628
|
+
*/
|
|
1629
|
+
export interface PricePageListItem {
|
|
1630
|
+
/** Price page ID (price_page.price_page_uid) */
|
|
1631
|
+
pricePageUid: number;
|
|
1632
|
+
/** P21 price page type code */
|
|
1633
|
+
pricePageTypeCd: number;
|
|
1634
|
+
/** P21 manufacturing class ID (max 255 chars) */
|
|
1635
|
+
mfgClassId: string | null;
|
|
1636
|
+
/** P21 supplier ID */
|
|
1637
|
+
supplierId: number | null;
|
|
1638
|
+
/** P21 product group ID (max 8 chars) */
|
|
1639
|
+
productGroupId: string | null;
|
|
1640
|
+
/** P21 discount group ID (max 8 chars) */
|
|
1641
|
+
discountGroupId: string | null;
|
|
1642
|
+
/** P21 major group ID (max 8 chars) */
|
|
1643
|
+
majorGroupId: string | null;
|
|
1644
|
+
/** Description of the price page (max 255 chars) */
|
|
1645
|
+
description: string | null;
|
|
1646
|
+
/** P21 pricing method code */
|
|
1647
|
+
pricingMethodCd: number;
|
|
1648
|
+
/** P21 source price code */
|
|
1649
|
+
sourcePriceCd: number | null;
|
|
1650
|
+
/** P21 price on the price page */
|
|
1651
|
+
price: number | null;
|
|
1652
|
+
/** Date the row takes effect (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1653
|
+
effectiveDate: string;
|
|
1654
|
+
/** Date the row expires (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1655
|
+
expirationDate: string;
|
|
1656
|
+
/** P21 contract number on the price page (max 40 chars) */
|
|
1657
|
+
contractNumber: string | null;
|
|
1658
|
+
/** P21 calculation method code */
|
|
1659
|
+
calculationMethodCd: number;
|
|
1660
|
+
/** P21 calculation value 1 on the price page */
|
|
1661
|
+
calculationValue1: number;
|
|
1662
|
+
/** P21 calculation value 2 on the price page */
|
|
1663
|
+
calculationValue2: number;
|
|
1664
|
+
/** P21 calculation value 3 on the price page */
|
|
1665
|
+
calculationValue3: number;
|
|
1666
|
+
/** P21 calculation value 4 on the price page */
|
|
1667
|
+
calculationValue4: number;
|
|
1668
|
+
/** P21 calculation value 5 on the price page */
|
|
1669
|
+
calculationValue5: number;
|
|
1670
|
+
/** P21 calculation value 6 on the price page */
|
|
1671
|
+
calculationValue6: number;
|
|
1672
|
+
/** P21 calculation value 7 on the price page */
|
|
1673
|
+
calculationValue7: number;
|
|
1674
|
+
/** P21 calculation value 8 on the price page */
|
|
1675
|
+
calculationValue8: number;
|
|
1676
|
+
/** P21 calculation value 9 on the price page */
|
|
1677
|
+
calculationValue9: number;
|
|
1678
|
+
/** P21 calculation value 10 on the price page */
|
|
1679
|
+
calculationValue10: number;
|
|
1680
|
+
/** P21 calculation value 11 on the price page */
|
|
1681
|
+
calculationValue11: number;
|
|
1682
|
+
/** P21 calculation value 12 on the price page */
|
|
1683
|
+
calculationValue12: number;
|
|
1684
|
+
/** P21 calculation value 13 on the price page */
|
|
1685
|
+
calculationValue13: number;
|
|
1686
|
+
/** P21 calculation value 14 on the price page */
|
|
1687
|
+
calculationValue14: number;
|
|
1688
|
+
/** P21 calculation value 15 on the price page */
|
|
1689
|
+
calculationValue15: number;
|
|
1690
|
+
/** Quantity break 1 on the price page */
|
|
1691
|
+
break1: number;
|
|
1692
|
+
/** Quantity break 2 on the price page */
|
|
1693
|
+
break2: number;
|
|
1694
|
+
/** Quantity break 3 on the price page */
|
|
1695
|
+
break3: number;
|
|
1696
|
+
/** Quantity break 4 on the price page */
|
|
1697
|
+
break4: number;
|
|
1698
|
+
/** Quantity break 5 on the price page */
|
|
1699
|
+
break5: number;
|
|
1700
|
+
/** Quantity break 6 on the price page */
|
|
1701
|
+
break6: number;
|
|
1702
|
+
/** Quantity break 7 on the price page */
|
|
1703
|
+
break7: number;
|
|
1704
|
+
/** Quantity break 8 on the price page */
|
|
1705
|
+
break8: number;
|
|
1706
|
+
/** Quantity break 9 on the price page */
|
|
1707
|
+
break9: number;
|
|
1708
|
+
/** Quantity break 10 on the price page */
|
|
1709
|
+
break10: number;
|
|
1710
|
+
/** Quantity break 11 on the price page */
|
|
1711
|
+
break11: number;
|
|
1712
|
+
/** Quantity break 12 on the price page */
|
|
1713
|
+
break12: number;
|
|
1714
|
+
/** Quantity break 13 on the price page */
|
|
1715
|
+
break13: number;
|
|
1716
|
+
/** Quantity break 14 on the price page */
|
|
1717
|
+
break14: number;
|
|
1718
|
+
/** P21 other cost 1 on the price page */
|
|
1719
|
+
otherCost1: number | null;
|
|
1720
|
+
/** P21 other cost 2 on the price page */
|
|
1721
|
+
otherCost2: number | null;
|
|
1722
|
+
/** P21 other cost 3 on the price page */
|
|
1723
|
+
otherCost3: number | null;
|
|
1724
|
+
/** P21 other cost 4 on the price page */
|
|
1725
|
+
otherCost4: number | null;
|
|
1726
|
+
/** P21 other cost 5 on the price page */
|
|
1727
|
+
otherCost5: number | null;
|
|
1728
|
+
/** P21 other cost 6 on the price page */
|
|
1729
|
+
otherCost6: number | null;
|
|
1730
|
+
/** P21 other cost 7 on the price page */
|
|
1731
|
+
otherCost7: number | null;
|
|
1732
|
+
/** P21 other cost 8 on the price page */
|
|
1733
|
+
otherCost8: number | null;
|
|
1734
|
+
/** P21 other cost 9 on the price page */
|
|
1735
|
+
otherCost9: number | null;
|
|
1736
|
+
/** P21 other cost 10 on the price page */
|
|
1737
|
+
otherCost10: number | null;
|
|
1738
|
+
/** P21 other cost 11 on the price page */
|
|
1739
|
+
otherCost11: number | null;
|
|
1740
|
+
/** P21 other cost 12 on the price page */
|
|
1741
|
+
otherCost12: number | null;
|
|
1742
|
+
/** P21 other cost 13 on the price page */
|
|
1743
|
+
otherCost13: number | null;
|
|
1744
|
+
/** P21 other cost 14 on the price page */
|
|
1745
|
+
otherCost14: number | null;
|
|
1746
|
+
/** P21 other cost 15 on the price page */
|
|
1747
|
+
otherCost15: number | null;
|
|
1748
|
+
/** Unit of measure 1 on the price page (max 8 chars) */
|
|
1749
|
+
uom1: string | null;
|
|
1750
|
+
/** Unit of measure 2 on the price page (max 8 chars) */
|
|
1751
|
+
uom2: string | null;
|
|
1752
|
+
/** Unit of measure 3 on the price page (max 8 chars) */
|
|
1753
|
+
uom3: string | null;
|
|
1754
|
+
/** Unit of measure 4 on the price page (max 8 chars) */
|
|
1755
|
+
uom4: string | null;
|
|
1756
|
+
/** Unit of measure 5 on the price page (max 8 chars) */
|
|
1757
|
+
uom5: string | null;
|
|
1758
|
+
/** Unit of measure 6 on the price page (max 8 chars) */
|
|
1759
|
+
uom6: string | null;
|
|
1760
|
+
/** Unit of measure 7 on the price page (max 8 chars) */
|
|
1761
|
+
uom7: string | null;
|
|
1762
|
+
/** Unit of measure 8 on the price page (max 8 chars) */
|
|
1763
|
+
uom8: string | null;
|
|
1764
|
+
/** Unit of measure 9 on the price page (max 8 chars) */
|
|
1765
|
+
uom9: string | null;
|
|
1766
|
+
/** Unit of measure 10 on the price page (max 8 chars) */
|
|
1767
|
+
uom10: string | null;
|
|
1768
|
+
/** Unit of measure 11 on the price page (max 8 chars) */
|
|
1769
|
+
uom11: string | null;
|
|
1770
|
+
/** Unit of measure 12 on the price page (max 8 chars) */
|
|
1771
|
+
uom12: string | null;
|
|
1772
|
+
/** Unit of measure 13 on the price page (max 8 chars) */
|
|
1773
|
+
uom13: string | null;
|
|
1774
|
+
/** Unit of measure 14 on the price page (max 8 chars) */
|
|
1775
|
+
uom14: string | null;
|
|
1776
|
+
/** P21 totaling method code */
|
|
1777
|
+
totalingMethodCd: number;
|
|
1778
|
+
/** P21 totaling basis code */
|
|
1779
|
+
totalingBasisCd: number;
|
|
1780
|
+
/** Row status from P21 (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1781
|
+
rowStatusFlag: number;
|
|
1782
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1783
|
+
dateLastModified: string;
|
|
1784
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1785
|
+
dateCreated: string;
|
|
1786
|
+
/** P21 user who last changed the row (max 30 chars) */
|
|
1787
|
+
lastMaintainedBy: string;
|
|
1788
|
+
/** P21 other cost type code */
|
|
1789
|
+
otherCostTypeCd: number | null;
|
|
1790
|
+
/** P21 other cost value on the price page */
|
|
1791
|
+
otherCostValue: number | null;
|
|
1792
|
+
/** P21 other cost source code */
|
|
1793
|
+
otherCostSourceCd: number | null;
|
|
1794
|
+
/** P21 cost calculation method code */
|
|
1795
|
+
costCalculationMethodCd: number | null;
|
|
1796
|
+
/** P21 cost calculation value on the price page */
|
|
1797
|
+
costCalculationValue: number | null;
|
|
1798
|
+
/** P21 commission cost type code */
|
|
1799
|
+
commissionCostTypeCd: number | null;
|
|
1800
|
+
/** P21 commission cost value on the price page */
|
|
1801
|
+
commissionCostValue: number | null;
|
|
1802
|
+
/** P21 commission cost source code */
|
|
1803
|
+
commissionCostSourceCd: number | null;
|
|
1804
|
+
/** P21 commission cost calculation method code */
|
|
1805
|
+
commissionCostCalcMethodCd: number | null;
|
|
1806
|
+
/** P21 commission cost calculation value on the price page */
|
|
1807
|
+
commissionCostCalcValue: number | null;
|
|
1808
|
+
/** P21 price page ID (max 20 chars) */
|
|
1809
|
+
pricePageId: string | null;
|
|
1810
|
+
/** P21 customer ID (customer.customer_id) */
|
|
1811
|
+
customerId: number | null;
|
|
1812
|
+
/** Customer part number on the price page (max 40 chars) */
|
|
1813
|
+
customerPartNo: string | null;
|
|
1814
|
+
/** P21 company ID (max 8 chars) */
|
|
1815
|
+
companyId: string | null;
|
|
1816
|
+
/** Item ID (inv_mast.inv_mast_uid) */
|
|
1817
|
+
invMastUid: number | null;
|
|
1818
|
+
/** P21 user who created the row (max 255 chars) */
|
|
1819
|
+
createdBy: string | null;
|
|
1820
|
+
/** P21 commission cost calculation value 1 on the price page */
|
|
1821
|
+
commCostCalcValue1: number | null;
|
|
1822
|
+
/** P21 commission cost calculation value 2 on the price page */
|
|
1823
|
+
commCostCalcValue2: number | null;
|
|
1824
|
+
/** P21 commission cost calculation value 3 on the price page */
|
|
1825
|
+
commCostCalcValue3: number | null;
|
|
1826
|
+
/** P21 commission cost calculation value 4 on the price page */
|
|
1827
|
+
commCostCalcValue4: number | null;
|
|
1828
|
+
/** P21 commission cost calculation value 5 on the price page */
|
|
1829
|
+
commCostCalcValue5: number | null;
|
|
1830
|
+
/** P21 commission cost calculation value 6 on the price page */
|
|
1831
|
+
commCostCalcValue6: number | null;
|
|
1832
|
+
/** P21 commission cost calculation value 7 on the price page */
|
|
1833
|
+
commCostCalcValue7: number | null;
|
|
1834
|
+
/** P21 commission cost calculation value 8 on the price page */
|
|
1835
|
+
commCostCalcValue8: number | null;
|
|
1836
|
+
/** P21 commission cost calculation value 9 on the price page */
|
|
1837
|
+
commCostCalcValue9: number | null;
|
|
1838
|
+
/** P21 commission cost calculation value 10 on the price page */
|
|
1839
|
+
commCostCalcValue10: number | null;
|
|
1840
|
+
/** P21 commission cost calculation value 11 on the price page */
|
|
1841
|
+
commCostCalcValue11: number | null;
|
|
1842
|
+
/** P21 commission cost calculation value 12 on the price page */
|
|
1843
|
+
commCostCalcValue12: number | null;
|
|
1844
|
+
/** P21 commission cost calculation value 13 on the price page */
|
|
1845
|
+
commCostCalcValue13: number | null;
|
|
1846
|
+
/** P21 commission cost calculation value 14 on the price page */
|
|
1847
|
+
commCostCalcValue14: number | null;
|
|
1848
|
+
/** P21 commission cost calculation value 15 on the price page */
|
|
1849
|
+
commCostCalcValue15: number | null;
|
|
1850
|
+
/** P21 currency ID */
|
|
1851
|
+
currencyId: number | null;
|
|
1852
|
+
/** P21 currency ID the price page values are stated in */
|
|
1853
|
+
valuesCurrencyId: number | null;
|
|
1854
|
+
/** P21 calculator_type on the price page (max 1 chars) */
|
|
1855
|
+
calculatorType: string;
|
|
1856
|
+
/** P21 apply_pp_to_mro_cd on the price page */
|
|
1857
|
+
applyPpToMroCd: number;
|
|
1858
|
+
/**
|
|
1859
|
+
* When the price page was last sent on an 832 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30
|
|
1860
|
+
* 15:50:49)
|
|
1861
|
+
*/
|
|
1862
|
+
dateLastSentOn832: string | null;
|
|
1863
|
+
/**
|
|
1864
|
+
* When the price page was deleted in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49)
|
|
1865
|
+
*/
|
|
1866
|
+
datePageDeleted: string | null;
|
|
1867
|
+
/** Price family ID (price_family.price_family_uid) */
|
|
1868
|
+
priceFamilyUid: number | null;
|
|
1869
|
+
/** P21 round_to_next_dollar on the price page */
|
|
1870
|
+
roundToNextDollar: number | null;
|
|
1871
|
+
/** P21 strategic_price_applies_to_cd on the price page */
|
|
1872
|
+
strategicPriceAppliesToCd: number;
|
|
1873
|
+
/** Peer price page ID (price_page.price_page_uid) */
|
|
1874
|
+
peerPricePageUid: number | null;
|
|
1875
|
+
/** P21 contract line ID */
|
|
1876
|
+
contractLineUid: number | null;
|
|
1877
|
+
/** P21 on_contract_flag on the price page (max 1 chars) */
|
|
1878
|
+
onContractFlag: string;
|
|
1879
|
+
/** P21 apply_freight_factor on the price page (max 1 chars) */
|
|
1880
|
+
applyFreightFactor: string;
|
|
1881
|
+
/** P21 freight_factor_source_cd on the price page */
|
|
1882
|
+
freightFactorSourceCd: number | null;
|
|
1883
|
+
/** P21 no_charge_flag on the price page (max 1 chars) */
|
|
1884
|
+
noChargeFlag: string | null;
|
|
1885
|
+
/** P21 non_stock_items_only_flag on the price page (max 1 chars) */
|
|
1886
|
+
nonStockItemsOnlyFlag: string;
|
|
1887
|
+
/** P21 apply_pp_to_sop_cd on the price page */
|
|
1888
|
+
applyPpToSopCd: number;
|
|
1889
|
+
/** P21 price_override on the price page (max 1 chars) */
|
|
1890
|
+
priceOverride: string;
|
|
1891
|
+
/** P21 rebate_margin on the price page */
|
|
1892
|
+
rebateMargin: number | null;
|
|
1893
|
+
/** P21 upper_margin_variance on the price page */
|
|
1894
|
+
upperMarginVariance: number | null;
|
|
1895
|
+
/** P21 lower_margin_variance on the price page */
|
|
1896
|
+
lowerMarginVariance: number | null;
|
|
1897
|
+
/** P21 exclude_order_level_disc_flag on the price page (max 1 chars) */
|
|
1898
|
+
excludeOrderLevelDiscFlag: string | null;
|
|
1899
|
+
/** P21 rolled_item_pricing_type_cd on the price page */
|
|
1900
|
+
rolledItemPricingTypeCd: number | null;
|
|
1901
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
1902
|
+
updateCd: number;
|
|
1903
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
1904
|
+
processCd: number;
|
|
1905
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1906
|
+
statusCd: number;
|
|
1907
|
+
[key: string]: unknown;
|
|
1908
|
+
}
|
|
1909
|
+
/** Returned by: api.pricing.pricePage.list(params) */
|
|
1910
|
+
export type PricePageListData = PricePageListItem[];
|
|
1911
|
+
/**
|
|
1912
|
+
* List Price Page Dealer Commission Rows
|
|
1913
|
+
* Response data for GET /price-page-dealer-commission — MINIMUM fields, extras pass through
|
|
1914
|
+
*
|
|
1915
|
+
* Returned by: api.pricing.pricePageDealerCommission.list(params) (array items)
|
|
1916
|
+
* Returned by: api.pricing.pricePageDealerCommission.get(pricePageDealerCommUid)
|
|
1917
|
+
*/
|
|
1918
|
+
export interface PricePageDealerCommissionListItem {
|
|
1919
|
+
/** Price page dealer commission ID */
|
|
1920
|
+
pricePageDealerCommUid: number;
|
|
1921
|
+
/** Price page ID (price_page.price_page_uid) */
|
|
1922
|
+
pricePageUid: number;
|
|
1923
|
+
/** P21 dealer commission calculation method code */
|
|
1924
|
+
dealerCommissionCalcMethCd: number;
|
|
1925
|
+
/** P21 dealer commission calculation value 1 */
|
|
1926
|
+
dealerCommCalcValue1: number;
|
|
1927
|
+
/** P21 dealer commission calculation value 2 */
|
|
1928
|
+
dealerCommCalcValue2: number;
|
|
1929
|
+
/** P21 dealer commission calculation value 3 */
|
|
1930
|
+
dealerCommCalcValue3: number;
|
|
1931
|
+
/** P21 dealer commission calculation value 4 */
|
|
1932
|
+
dealerCommCalcValue4: number;
|
|
1933
|
+
/** P21 dealer commission calculation value 5 */
|
|
1934
|
+
dealerCommCalcValue5: number;
|
|
1935
|
+
/** P21 dealer commission calculation value 6 */
|
|
1936
|
+
dealerCommCalcValue6: number;
|
|
1937
|
+
/** P21 dealer commission calculation value 7 */
|
|
1938
|
+
dealerCommCalcValue7: number;
|
|
1939
|
+
/** P21 dealer commission calculation value 8 */
|
|
1940
|
+
dealerCommCalcValue8: number;
|
|
1941
|
+
/** P21 dealer commission calculation value 9 */
|
|
1942
|
+
dealerCommCalcValue9: number;
|
|
1943
|
+
/** P21 dealer commission calculation value 10 */
|
|
1944
|
+
dealerCommCalcValue10: number;
|
|
1945
|
+
/** P21 dealer commission calculation value 11 */
|
|
1946
|
+
dealerCommCalcValue11: number;
|
|
1947
|
+
/** P21 dealer commission calculation value 12 */
|
|
1948
|
+
dealerCommCalcValue12: number;
|
|
1949
|
+
/** P21 dealer commission calculation value 13 */
|
|
1950
|
+
dealerCommCalcValue13: number;
|
|
1951
|
+
/** P21 dealer commission calculation value 14 */
|
|
1952
|
+
dealerCommCalcValue14: number;
|
|
1953
|
+
/** P21 dealer commission calculation value 15 */
|
|
1954
|
+
dealerCommCalcValue15: number;
|
|
1955
|
+
/** P21 dealer commission quantity break 1 */
|
|
1956
|
+
dealerCommBreak1: number;
|
|
1957
|
+
/** P21 dealer commission quantity break 2 */
|
|
1958
|
+
dealerCommBreak2: number;
|
|
1959
|
+
/** P21 dealer commission quantity break 3 */
|
|
1960
|
+
dealerCommBreak3: number;
|
|
1961
|
+
/** P21 dealer commission quantity break 4 */
|
|
1962
|
+
dealerCommBreak4: number;
|
|
1963
|
+
/** P21 dealer commission quantity break 5 */
|
|
1964
|
+
dealerCommBreak5: number;
|
|
1965
|
+
/** P21 dealer commission quantity break 6 */
|
|
1966
|
+
dealerCommBreak6: number;
|
|
1967
|
+
/** P21 dealer commission quantity break 7 */
|
|
1968
|
+
dealerCommBreak7: number;
|
|
1969
|
+
/** P21 dealer commission quantity break 8 */
|
|
1970
|
+
dealerCommBreak8: number;
|
|
1971
|
+
/** P21 dealer commission quantity break 9 */
|
|
1972
|
+
dealerCommBreak9: number;
|
|
1973
|
+
/** P21 dealer commission quantity break 10 */
|
|
1974
|
+
dealerCommBreak10: number;
|
|
1975
|
+
/** P21 dealer commission quantity break 11 */
|
|
1976
|
+
dealerCommBreak11: number;
|
|
1977
|
+
/** P21 dealer commission quantity break 12 */
|
|
1978
|
+
dealerCommBreak12: number;
|
|
1979
|
+
/** P21 dealer commission quantity break 13 */
|
|
1980
|
+
dealerCommBreak13: number;
|
|
1981
|
+
/** P21 dealer commission quantity break 14 */
|
|
1982
|
+
dealerCommBreak14: number;
|
|
1983
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1984
|
+
dateCreated: string;
|
|
1985
|
+
/** P21 user who created the row (max 255 chars) */
|
|
1986
|
+
createdBy: string;
|
|
1987
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1988
|
+
dateLastModified: string;
|
|
1989
|
+
/** P21 user who last changed the row (max 255 chars) */
|
|
1990
|
+
lastMaintainedBy: string;
|
|
1991
|
+
/** P21 dealer commission unit of measure 1 (max 8 chars) */
|
|
1992
|
+
dealerCommUom1: string | null;
|
|
1993
|
+
/** P21 dealer commission unit of measure 2 (max 8 chars) */
|
|
1994
|
+
dealerCommUom2: string | null;
|
|
1995
|
+
/** P21 dealer commission unit of measure 3 (max 8 chars) */
|
|
1996
|
+
dealerCommUom3: string | null;
|
|
1997
|
+
/** P21 dealer commission unit of measure 4 (max 8 chars) */
|
|
1998
|
+
dealerCommUom4: string | null;
|
|
1999
|
+
/** P21 dealer commission unit of measure 5 (max 8 chars) */
|
|
2000
|
+
dealerCommUom5: string | null;
|
|
2001
|
+
/** P21 dealer commission unit of measure 6 (max 8 chars) */
|
|
2002
|
+
dealerCommUom6: string | null;
|
|
2003
|
+
/** P21 dealer commission unit of measure 7 (max 8 chars) */
|
|
2004
|
+
dealerCommUom7: string | null;
|
|
2005
|
+
/** P21 dealer commission unit of measure 8 (max 8 chars) */
|
|
2006
|
+
dealerCommUom8: string | null;
|
|
2007
|
+
/** P21 dealer commission unit of measure 9 (max 8 chars) */
|
|
2008
|
+
dealerCommUom9: string | null;
|
|
2009
|
+
/** P21 dealer commission unit of measure 10 (max 8 chars) */
|
|
2010
|
+
dealerCommUom10: string | null;
|
|
2011
|
+
/** P21 dealer commission unit of measure 11 (max 8 chars) */
|
|
2012
|
+
dealerCommUom11: string | null;
|
|
2013
|
+
/** P21 dealer commission unit of measure 12 (max 8 chars) */
|
|
2014
|
+
dealerCommUom12: string | null;
|
|
2015
|
+
/** P21 dealer commission unit of measure 13 (max 8 chars) */
|
|
2016
|
+
dealerCommUom13: string | null;
|
|
2017
|
+
/** P21 dealer commission unit of measure 14 (max 8 chars) */
|
|
2018
|
+
dealerCommUom14: string | null;
|
|
2019
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
2020
|
+
updateCd: number;
|
|
2021
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
2022
|
+
processCd: number;
|
|
2023
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
2024
|
+
statusCd: number;
|
|
2025
|
+
[key: string]: unknown;
|
|
2026
|
+
}
|
|
2027
|
+
/** Returned by: api.pricing.pricePageDealerCommission.list(params) */
|
|
2028
|
+
export type PricePageDealerCommissionListData = PricePageDealerCommissionListItem[];
|
|
2029
|
+
/**
|
|
2030
|
+
* Get Price Page Dealer Commission Row
|
|
2031
|
+
* Response data for GET /price-page-dealer-commission/{pricePageDealerCommUid} — MINIMUM fields,
|
|
2032
|
+
* extras pass through
|
|
2033
|
+
*
|
|
2034
|
+
* Returned by: api.pricing.pricePageDealerCommission.get(pricePageDealerCommUid)
|
|
2035
|
+
*/
|
|
2036
|
+
export type PricePageDealerCommissionGetData = PricePageDealerCommissionListItem;
|
|
2037
|
+
/**
|
|
2038
|
+
* List Price Page Item Rows
|
|
2039
|
+
* Response data for GET /price-page-item — MINIMUM fields, extras pass through
|
|
2040
|
+
*
|
|
2041
|
+
* Returned by: api.pricing.pricePageItem.list(params) (array items)
|
|
2042
|
+
* Returned by: api.pricing.pricePageItem.get(pricePageItemUid)
|
|
2043
|
+
*/
|
|
2044
|
+
export interface PricePageItemListItem {
|
|
2045
|
+
/** Price page item ID */
|
|
2046
|
+
pricePageItemUid: number;
|
|
2047
|
+
/** Price page ID (price_page.price_page_uid) */
|
|
2048
|
+
pricePageUid: number;
|
|
2049
|
+
/** Item ID (inv_mast.inv_mast_uid) */
|
|
2050
|
+
invMastUid: number;
|
|
2051
|
+
/** Date the item takes effect on the price page (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2052
|
+
effectiveDate: string;
|
|
2053
|
+
/** Date the row expires (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2054
|
+
expirationDate: string;
|
|
2055
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2056
|
+
dateCreated: string;
|
|
2057
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2058
|
+
dateLastModified: string;
|
|
2059
|
+
/** P21 user who last changed the row (max 30 chars) */
|
|
2060
|
+
lastMaintainedBy: string;
|
|
2061
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
2062
|
+
updateCd: number;
|
|
2063
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
2064
|
+
processCd: number;
|
|
2065
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
2066
|
+
statusCd: number;
|
|
2067
|
+
[key: string]: unknown;
|
|
2068
|
+
}
|
|
2069
|
+
/** Returned by: api.pricing.pricePageItem.list(params) */
|
|
2070
|
+
export type PricePageItemListData = PricePageItemListItem[];
|
|
2071
|
+
/**
|
|
2072
|
+
* Get Price Page Item Row
|
|
2073
|
+
* Response data for GET /price-page-item/{pricePageItemUid} — MINIMUM fields, extras pass through
|
|
2074
|
+
*
|
|
2075
|
+
* Returned by: api.pricing.pricePageItem.get(pricePageItemUid)
|
|
2076
|
+
*/
|
|
2077
|
+
export type PricePageItemGetData = PricePageItemListItem;
|
|
2078
|
+
/**
|
|
2079
|
+
* List Price Page PO Cost Calculation Rows
|
|
2080
|
+
* Response data for GET /price-page-po-cost-calc — MINIMUM fields, extras pass through
|
|
2081
|
+
*
|
|
2082
|
+
* Returned by: api.pricing.pricePagePoCostCalc.list(params) (array items)
|
|
2083
|
+
* Returned by: api.pricing.pricePagePoCostCalc.get(pricePagePoCostCalcUid)
|
|
2084
|
+
*/
|
|
2085
|
+
export interface PricePagePoCostCalcListItem {
|
|
2086
|
+
/** Price page PO cost calculation ID */
|
|
2087
|
+
pricePagePoCostCalcUid: number;
|
|
2088
|
+
/** Price page ID (price_page.price_page_uid) */
|
|
2089
|
+
pricePageUid: number;
|
|
2090
|
+
/** P21 company ID (max 8 chars) */
|
|
2091
|
+
companyId: string;
|
|
2092
|
+
/** P21 customer ID (customer.customer_id) */
|
|
2093
|
+
customerId: number;
|
|
2094
|
+
/** P21 contract number (max 40 chars) */
|
|
2095
|
+
contractNo: string;
|
|
2096
|
+
/** P21 PO cost multiplier */
|
|
2097
|
+
poCostMultiplier: number;
|
|
2098
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2099
|
+
dateCreated: string;
|
|
2100
|
+
/** P21 user who created the row (max 255 chars) */
|
|
2101
|
+
createdBy: string;
|
|
2102
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2103
|
+
dateLastModified: string;
|
|
2104
|
+
/** P21 user who last changed the row (max 255 chars) */
|
|
2105
|
+
lastMaintainedBy: string;
|
|
2106
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
2107
|
+
updateCd: number;
|
|
2108
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
2109
|
+
processCd: number;
|
|
2110
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
2111
|
+
statusCd: number;
|
|
2112
|
+
[key: string]: unknown;
|
|
2113
|
+
}
|
|
2114
|
+
/** Returned by: api.pricing.pricePagePoCostCalc.list(params) */
|
|
2115
|
+
export type PricePagePoCostCalcListData = PricePagePoCostCalcListItem[];
|
|
2116
|
+
/**
|
|
2117
|
+
* Get Price Page PO Cost Calculation Row
|
|
2118
|
+
* Response data for GET /price-page-po-cost-calc/{pricePagePoCostCalcUid} — MINIMUM fields, extras
|
|
2119
|
+
* pass through
|
|
2120
|
+
*
|
|
2121
|
+
* Returned by: api.pricing.pricePagePoCostCalc.get(pricePagePoCostCalcUid)
|
|
2122
|
+
*/
|
|
2123
|
+
export type PricePagePoCostCalcGetData = PricePagePoCostCalcListItem;
|
|
2124
|
+
/**
|
|
2125
|
+
* List Price Page Price Family Rows
|
|
2126
|
+
* Response data for GET /price-page-pricefam — MINIMUM fields, extras pass through
|
|
2127
|
+
*
|
|
2128
|
+
* Returned by: api.pricing.pricePagePricefam.list(params) (array items)
|
|
2129
|
+
* Returned by: api.pricing.pricePagePricefam.get(pricePagePricefamUid)
|
|
2130
|
+
*/
|
|
2131
|
+
export interface PricePagePricefamListItem {
|
|
2132
|
+
/** Price page price family ID */
|
|
2133
|
+
pricePagePricefamUid: number;
|
|
2134
|
+
/** Price page ID (price_page.price_page_uid) */
|
|
2135
|
+
pricePageUid: number;
|
|
2136
|
+
/** Price family ID (price_family.price_family_uid) */
|
|
2137
|
+
priceFamilyUid: number;
|
|
2138
|
+
/** Date the row takes effect (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2139
|
+
effectiveDate: string;
|
|
2140
|
+
/** Date the row expires (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2141
|
+
expirationDate: string;
|
|
2142
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2143
|
+
dateCreated: string;
|
|
2144
|
+
/** P21 user who created the row (max 255 chars) */
|
|
2145
|
+
createdBy: string;
|
|
2146
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2147
|
+
dateLastModified: string;
|
|
2148
|
+
/** P21 user who last changed the row (max 255 chars) */
|
|
2149
|
+
lastMaintainedBy: string;
|
|
2150
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
2151
|
+
updateCd: number;
|
|
2152
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
2153
|
+
processCd: number;
|
|
2154
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
2155
|
+
statusCd: number;
|
|
2156
|
+
[key: string]: unknown;
|
|
2157
|
+
}
|
|
2158
|
+
/** Returned by: api.pricing.pricePagePricefam.list(params) */
|
|
2159
|
+
export type PricePagePricefamListData = PricePagePricefamListItem[];
|
|
2160
|
+
/**
|
|
2161
|
+
* Get Price Page Price Family Row
|
|
2162
|
+
* Response data for GET /price-page-pricefam/{pricePagePricefamUid} — MINIMUM fields, extras pass
|
|
2163
|
+
* through
|
|
2164
|
+
*
|
|
2165
|
+
* Returned by: api.pricing.pricePagePricefam.get(pricePagePricefamUid)
|
|
2166
|
+
*/
|
|
2167
|
+
export type PricePagePricefamGetData = PricePagePricefamListItem;
|
|
2168
|
+
/**
|
|
2169
|
+
* List Price Page Product Group Rows
|
|
2170
|
+
* Response data for GET /price-page-prodgrp — MINIMUM fields, extras pass through
|
|
2171
|
+
*
|
|
2172
|
+
* Returned by: api.pricing.pricePageProdgrp.list(params) (array items)
|
|
2173
|
+
* Returned by: api.pricing.pricePageProdgrp.get(pricePageProdgrpUid)
|
|
2174
|
+
*/
|
|
2175
|
+
export interface PricePageProdgrpListItem {
|
|
2176
|
+
/** Price page product group ID */
|
|
2177
|
+
pricePageProdgrpUid: number;
|
|
2178
|
+
/** Price page ID (price_page.price_page_uid) */
|
|
2179
|
+
pricePageUid: number;
|
|
2180
|
+
/** P21 product group ID (max 8 chars) */
|
|
2181
|
+
productGroupId: string;
|
|
2182
|
+
/** P21 company ID (max 8 chars) */
|
|
2183
|
+
companyId: string;
|
|
2184
|
+
/** Date the row takes effect (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2185
|
+
effectiveDate: string;
|
|
2186
|
+
/** Date the row expires (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2187
|
+
expirationDate: string;
|
|
2188
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2189
|
+
dateCreated: string;
|
|
2190
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2191
|
+
dateLastModified: string;
|
|
2192
|
+
/** P21 user who last changed the row (max 30 chars) */
|
|
2193
|
+
lastMaintainedBy: string;
|
|
2194
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
2195
|
+
updateCd: number;
|
|
2196
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
2197
|
+
processCd: number;
|
|
2198
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
2199
|
+
statusCd: number;
|
|
2200
|
+
[key: string]: unknown;
|
|
2201
|
+
}
|
|
2202
|
+
/** Returned by: api.pricing.pricePageProdgrp.list(params) */
|
|
2203
|
+
export type PricePageProdgrpListData = PricePageProdgrpListItem[];
|
|
2204
|
+
/**
|
|
2205
|
+
* Get Price Page Product Group Row
|
|
2206
|
+
* Response data for GET /price-page-prodgrp/{pricePageProdgrpUid} — MINIMUM fields, extras pass
|
|
2207
|
+
* through
|
|
2208
|
+
*
|
|
2209
|
+
* Returned by: api.pricing.pricePageProdgrp.get(pricePageProdgrpUid)
|
|
2210
|
+
*/
|
|
2211
|
+
export type PricePageProdgrpGetData = PricePageProdgrpListItem;
|
|
2212
|
+
/**
|
|
2213
|
+
* List Price Page Secondary Rebate Rows
|
|
2214
|
+
* Response data for GET /price-page-secondary-rebate — MINIMUM fields, extras pass through
|
|
2215
|
+
*
|
|
2216
|
+
* Returned by: api.pricing.pricePageSecondaryRebate.list(params) (array items)
|
|
2217
|
+
* Returned by: api.pricing.pricePageSecondaryRebate.get(pricePageSecondaryRebateUid)
|
|
2218
|
+
*/
|
|
2219
|
+
export interface PricePageSecondaryRebateListItem {
|
|
2220
|
+
/** Price page secondary rebate ID */
|
|
2221
|
+
pricePageSecondaryRebateUid: number;
|
|
2222
|
+
/** Price page ID (price_page.price_page_uid) */
|
|
2223
|
+
pricePageUid: number;
|
|
2224
|
+
/** P21 secondary rebate type code */
|
|
2225
|
+
secondaryRebateTypeCd: number | null;
|
|
2226
|
+
/** P21 secondary rebate calculation method code */
|
|
2227
|
+
secondaryRebateCalcMethCd: number | null;
|
|
2228
|
+
/** P21 secondary rebate value */
|
|
2229
|
+
secondaryRebateValue: number | null;
|
|
2230
|
+
/** P21 secondary rebate source code */
|
|
2231
|
+
secondaryRebateSourceCd: number | null;
|
|
2232
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2233
|
+
dateCreated: string;
|
|
2234
|
+
/** P21 user who created the row (max 255 chars) */
|
|
2235
|
+
createdBy: string;
|
|
2236
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2237
|
+
dateLastModified: string;
|
|
2238
|
+
/** P21 user who last changed the row (max 255 chars) */
|
|
2239
|
+
lastMaintainedBy: string;
|
|
2240
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
2241
|
+
updateCd: number;
|
|
2242
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
2243
|
+
processCd: number;
|
|
2244
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
2245
|
+
statusCd: number;
|
|
2246
|
+
[key: string]: unknown;
|
|
2247
|
+
}
|
|
2248
|
+
/** Returned by: api.pricing.pricePageSecondaryRebate.list(params) */
|
|
2249
|
+
export type PricePageSecondaryRebateListData = PricePageSecondaryRebateListItem[];
|
|
2250
|
+
/**
|
|
2251
|
+
* Get Price Page Secondary Rebate Row
|
|
2252
|
+
* Response data for GET /price-page-secondary-rebate/{pricePageSecondaryRebateUid} — MINIMUM
|
|
2253
|
+
* fields, extras pass through
|
|
2254
|
+
*
|
|
2255
|
+
* Returned by: api.pricing.pricePageSecondaryRebate.get(pricePageSecondaryRebateUid)
|
|
2256
|
+
*/
|
|
2257
|
+
export type PricePageSecondaryRebateGetData = PricePageSecondaryRebateListItem;
|
|
2258
|
+
/**
|
|
2259
|
+
* List Price Page Supplier Discount Rows
|
|
2260
|
+
* Response data for GET /price-page-suppdisc — MINIMUM fields, extras pass through
|
|
2261
|
+
*
|
|
2262
|
+
* Returned by: api.pricing.pricePageSuppdisc.list(params) (array items)
|
|
2263
|
+
* Returned by: api.pricing.pricePageSuppdisc.get(pricePageSuppdiscUid)
|
|
2264
|
+
*/
|
|
2265
|
+
export interface PricePageSuppdiscListItem {
|
|
2266
|
+
/** Price page supplier discount group ID */
|
|
2267
|
+
pricePageSuppdiscUid: number;
|
|
2268
|
+
/** Price page ID (price_page.price_page_uid) */
|
|
2269
|
+
pricePageUid: number;
|
|
2270
|
+
/** P21 supplier ID */
|
|
2271
|
+
supplierId: number;
|
|
2272
|
+
/** P21 discount group ID (max 8 chars) */
|
|
2273
|
+
discountGroupId: string;
|
|
2274
|
+
/** Date the row takes effect (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2275
|
+
effectiveDate: string;
|
|
2276
|
+
/** Date the row expires (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2277
|
+
expirationDate: string;
|
|
2278
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2279
|
+
dateCreated: string;
|
|
2280
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2281
|
+
dateLastModified: string;
|
|
2282
|
+
/** P21 user who last changed the row (max 30 chars) */
|
|
2283
|
+
lastMaintainedBy: string;
|
|
2284
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
2285
|
+
updateCd: number;
|
|
2286
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
2287
|
+
processCd: number;
|
|
2288
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
2289
|
+
statusCd: number;
|
|
2290
|
+
[key: string]: unknown;
|
|
2291
|
+
}
|
|
2292
|
+
/** Returned by: api.pricing.pricePageSuppdisc.list(params) */
|
|
2293
|
+
export type PricePageSuppdiscListData = PricePageSuppdiscListItem[];
|
|
2294
|
+
/**
|
|
2295
|
+
* Get Price Page Supplier Discount Row
|
|
2296
|
+
* Response data for GET /price-page-suppdisc/{pricePageSuppdiscUid} — MINIMUM fields, extras pass
|
|
2297
|
+
* through
|
|
2298
|
+
*
|
|
2299
|
+
* Returned by: api.pricing.pricePageSuppdisc.get(pricePageSuppdiscUid)
|
|
2300
|
+
*/
|
|
2301
|
+
export type PricePageSuppdiscGetData = PricePageSuppdiscListItem;
|
|
2302
|
+
/**
|
|
2303
|
+
* List Price Page Supplier Rows
|
|
2304
|
+
* Response data for GET /price-page-supplier — MINIMUM fields, extras pass through
|
|
2305
|
+
*
|
|
2306
|
+
* Returned by: api.pricing.pricePageSupplier.list(params) (array items)
|
|
2307
|
+
* Returned by: api.pricing.pricePageSupplier.get(pricePageSupplierUid)
|
|
2308
|
+
*/
|
|
2309
|
+
export interface PricePageSupplierListItem {
|
|
2310
|
+
/** Price page supplier ID */
|
|
2311
|
+
pricePageSupplierUid: number;
|
|
2312
|
+
/** Price page ID (price_page.price_page_uid) */
|
|
2313
|
+
pricePageUid: number;
|
|
2314
|
+
/** P21 supplier ID */
|
|
2315
|
+
supplierId: number;
|
|
2316
|
+
/** Date the row takes effect (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2317
|
+
effectiveDate: string;
|
|
2318
|
+
/** Date the row expires (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2319
|
+
expirationDate: string;
|
|
2320
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2321
|
+
dateCreated: string;
|
|
2322
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2323
|
+
dateLastModified: string;
|
|
2324
|
+
/** P21 user who last changed the row (max 30 chars) */
|
|
2325
|
+
lastMaintainedBy: string;
|
|
2326
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
2327
|
+
updateCd: number;
|
|
2328
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
2329
|
+
processCd: number;
|
|
2330
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
2331
|
+
statusCd: number;
|
|
2332
|
+
[key: string]: unknown;
|
|
2333
|
+
}
|
|
2334
|
+
/** Returned by: api.pricing.pricePageSupplier.list(params) */
|
|
2335
|
+
export type PricePageSupplierListData = PricePageSupplierListItem[];
|
|
2336
|
+
/**
|
|
2337
|
+
* Get Price Page Supplier Row
|
|
2338
|
+
* Response data for GET /price-page-supplier/{pricePageSupplierUid} — MINIMUM fields, extras pass
|
|
2339
|
+
* through
|
|
2340
|
+
*
|
|
2341
|
+
* Returned by: api.pricing.pricePageSupplier.get(pricePageSupplierUid)
|
|
2342
|
+
*/
|
|
2343
|
+
export type PricePageSupplierGetData = PricePageSupplierListItem;
|
|
2344
|
+
/**
|
|
2345
|
+
* List Price Page Type To Company Links
|
|
2346
|
+
* Response data for GET /price-page-type-x-company — MINIMUM fields, extras pass through
|
|
2347
|
+
*
|
|
2348
|
+
* Returned by: api.pricing.pricePageTypeXCompany.list(params) (array items)
|
|
2349
|
+
* Returned by: api.pricing.pricePageTypeXCompany.get(pricePageTypeXCompanyUid)
|
|
2350
|
+
*/
|
|
2351
|
+
export interface PricePageTypeXCompanyListItem {
|
|
2352
|
+
/** Price page type to company link ID */
|
|
2353
|
+
pricePageTypeXCompanyUid: number;
|
|
2354
|
+
/** P21 company ID (max 8 chars) */
|
|
2355
|
+
companyId: string;
|
|
2356
|
+
/** P21 price page type code */
|
|
2357
|
+
pricePageTypeCd: number;
|
|
2358
|
+
/** Sequence of the price page type for the company */
|
|
2359
|
+
sequenceNumber: number;
|
|
2360
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2361
|
+
dateLastModified: string;
|
|
2362
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2363
|
+
dateCreated: string;
|
|
2364
|
+
/** P21 user who last changed the row (max 30 chars) */
|
|
2365
|
+
lastMaintainedBy: string;
|
|
2366
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
2367
|
+
updateCd: number;
|
|
2368
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
2369
|
+
processCd: number;
|
|
2370
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
2371
|
+
statusCd: number;
|
|
2372
|
+
[key: string]: unknown;
|
|
2373
|
+
}
|
|
2374
|
+
/** Returned by: api.pricing.pricePageTypeXCompany.list(params) */
|
|
2375
|
+
export type PricePageTypeXCompanyListData = PricePageTypeXCompanyListItem[];
|
|
2376
|
+
/**
|
|
2377
|
+
* Get Price Page Type To Company Link
|
|
2378
|
+
* Response data for GET /price-page-type-x-company/{pricePageTypeXCompanyUid} — MINIMUM fields,
|
|
2379
|
+
* extras pass through
|
|
2380
|
+
*
|
|
2381
|
+
* Returned by: api.pricing.pricePageTypeXCompany.get(pricePageTypeXCompanyUid)
|
|
2382
|
+
*/
|
|
2383
|
+
export type PricePageTypeXCompanyGetData = PricePageTypeXCompanyListItem;
|
|
2384
|
+
/**
|
|
2385
|
+
* List Price Page To Book Links
|
|
2386
|
+
* Response data for GET /price-page-x-book — MINIMUM fields, extras pass through
|
|
2387
|
+
*
|
|
2388
|
+
* Returned by: api.pricing.pricePageXBook.list(params) (array items)
|
|
2389
|
+
* Returned by: api.pricing.pricePageXBook.get(pricePageXBookUid)
|
|
2390
|
+
*/
|
|
2391
|
+
export interface PricePageXBookListItem {
|
|
2392
|
+
/** Price page to book link ID (P21 price_page_x_book_uid) */
|
|
2393
|
+
pricePageXBookUid: number;
|
|
2394
|
+
/** Price book ID (price_book.price_book_uid) */
|
|
2395
|
+
priceBookUid: number;
|
|
2396
|
+
/** Price page ID (price_page.price_page_uid) */
|
|
2397
|
+
pricePageUid: number;
|
|
2398
|
+
/** Row status from P21 (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
2399
|
+
rowStatusFlag: number;
|
|
2400
|
+
/** When the link last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2401
|
+
dateLastModified: string;
|
|
2402
|
+
/** When the link was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2403
|
+
dateCreated: string;
|
|
2404
|
+
/** P21 user who last changed the link (max 30 chars) */
|
|
2405
|
+
lastMaintainedBy: string;
|
|
2406
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
2407
|
+
updateCd: number;
|
|
2408
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
2409
|
+
processCd: number;
|
|
2410
|
+
/**
|
|
2411
|
+
* Calculator type of the linked price page; the price engine splits cost pages from price pages
|
|
2412
|
+
* on it (max 1 chars)
|
|
2413
|
+
*/
|
|
2414
|
+
pricePageCalculatorType: string | null;
|
|
2415
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
2416
|
+
statusCd: number;
|
|
2417
|
+
[key: string]: unknown;
|
|
2418
|
+
}
|
|
2419
|
+
/** Returned by: api.pricing.pricePageXBook.list(params) */
|
|
2420
|
+
export type PricePageXBookListData = PricePageXBookListItem[];
|
|
2421
|
+
/**
|
|
2422
|
+
* Get Price Page To Book Link
|
|
2423
|
+
* Response data for GET /price-page-x-book/{pricePageXBookUid} — MINIMUM fields, extras pass
|
|
2424
|
+
* through
|
|
2425
|
+
*
|
|
2426
|
+
* Returned by: api.pricing.pricePageXBook.get(pricePageXBookUid)
|
|
2427
|
+
*/
|
|
2428
|
+
export type PricePageXBookGetData = PricePageXBookListItem;
|
|
2429
|
+
/**
|
|
2430
|
+
* Get Price Page
|
|
2431
|
+
* Response data for GET /price-page/{pricePageUid} — MINIMUM fields, extras pass through
|
|
2432
|
+
*
|
|
2433
|
+
* Returned by: api.pricing.pricePage.get(pricePageUid)
|
|
2434
|
+
*/
|
|
2435
|
+
export type PricePageGetData = PricePageListItem;
|
|
2436
|
+
/**
|
|
2437
|
+
* List Price Source To Company Links
|
|
2438
|
+
* Response data for GET /price-source-x-company — MINIMUM fields, extras pass through
|
|
2439
|
+
*
|
|
2440
|
+
* Returned by: api.pricing.priceSourceXCompany.list(params) (array items)
|
|
2441
|
+
* Returned by: api.pricing.priceSourceXCompany.get(priceSourceXCompanyUid)
|
|
2442
|
+
*/
|
|
2443
|
+
export interface PriceSourceXCompanyListItem {
|
|
2444
|
+
/** Price source to company link ID */
|
|
2445
|
+
priceSourceXCompanyUid: number;
|
|
2446
|
+
/** P21 company ID (max 8 chars) */
|
|
2447
|
+
companyId: string;
|
|
2448
|
+
/** P21 pricing type code */
|
|
2449
|
+
pricingTypeCd: number;
|
|
2450
|
+
/** P21 source type code */
|
|
2451
|
+
sourceTypeCd: number;
|
|
2452
|
+
/** P21 available_ind on the price source (max 1 chars) */
|
|
2453
|
+
availableInd: string;
|
|
2454
|
+
/** P21 used_in_zero_pricing_ind on the price source (max 1 chars) */
|
|
2455
|
+
usedInZeroPricingInd: string;
|
|
2456
|
+
/** Sequence of the price source for the company */
|
|
2457
|
+
sequenceNumber: number;
|
|
2458
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2459
|
+
dateLastModified: string;
|
|
2460
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2461
|
+
dateCreated: string;
|
|
2462
|
+
/** P21 user who last changed the row (max 30 chars) */
|
|
2463
|
+
lastMaintainedBy: string;
|
|
2464
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
2465
|
+
updateCd: number;
|
|
2466
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
2467
|
+
processCd: number;
|
|
2468
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
2469
|
+
statusCd: number;
|
|
2470
|
+
[key: string]: unknown;
|
|
2471
|
+
}
|
|
2472
|
+
/** Returned by: api.pricing.priceSourceXCompany.list(params) */
|
|
2473
|
+
export type PriceSourceXCompanyListData = PriceSourceXCompanyListItem[];
|
|
2474
|
+
/**
|
|
2475
|
+
* Get Price Source To Company Link
|
|
2476
|
+
* Response data for GET /price-source-x-company/{priceSourceXCompanyUid} — MINIMUM fields, extras
|
|
2477
|
+
* pass through
|
|
2478
|
+
*
|
|
2479
|
+
* Returned by: api.pricing.priceSourceXCompany.get(priceSourceXCompanyUid)
|
|
2480
|
+
*/
|
|
2481
|
+
export type PriceSourceXCompanyGetData = PriceSourceXCompanyListItem;
|
|
2482
|
+
/**
|
|
2483
|
+
* Shape of `items` (MINIMUM fields; reused wherever the same shape appears)
|
|
2484
|
+
* Per-item tax estimates
|
|
2485
|
+
*
|
|
2486
|
+
* Field `items` of TaxEngineCreateData
|
|
2487
|
+
*/
|
|
2488
|
+
export interface TaxEngineCreateDataItemsItem {
|
|
2489
|
+
/** P21 item ID */
|
|
2490
|
+
itemId: string;
|
|
2491
|
+
/** Inventory master UID, 0 when the item was not found */
|
|
2492
|
+
invMastUid: number;
|
|
2493
|
+
/** Quantity taxed */
|
|
2494
|
+
quantity: number;
|
|
2495
|
+
/** Unit of measure the unit price is expressed in */
|
|
2496
|
+
unitOfMeasure: string | null;
|
|
2497
|
+
/** Unit price taxed, from the request or the price engine */
|
|
2498
|
+
unitPrice: number | false;
|
|
2499
|
+
/** Estimated tax for this item (quantity x unit price x tax rate) */
|
|
2500
|
+
taxEstimate: number;
|
|
2501
|
+
[key: string]: unknown;
|
|
2502
|
+
}
|
|
2503
|
+
/**
|
|
2504
|
+
* Estimate Sales Tax
|
|
2505
|
+
* Response data for POST /tax-engine — MINIMUM fields, extras pass through
|
|
2506
|
+
*
|
|
2507
|
+
* Returned by: api.pricing.taxEngine.create(data)
|
|
2508
|
+
*/
|
|
2509
|
+
export interface TaxEngineCreateData {
|
|
2510
|
+
/** Total estimated tax across all items */
|
|
2511
|
+
taxEstimate: number;
|
|
2512
|
+
/** P21 customer ID the items were priced for */
|
|
2513
|
+
customerId: number;
|
|
2514
|
+
/** Postal code the tax rate was looked up for, exactly as sent (leading zeros kept) */
|
|
2515
|
+
postalCode: string;
|
|
2516
|
+
/** Tax rate applied, as a fraction (0.089 = 8.9%) */
|
|
2517
|
+
taxRate: number;
|
|
2518
|
+
/** Per-item tax estimates */
|
|
2519
|
+
items: TaxEngineCreateDataItemsItem[];
|
|
2520
|
+
[key: string]: unknown;
|
|
2521
|
+
}
|
|
2522
|
+
/**
|
|
2523
|
+
* Shape of `items` (MINIMUM fields; reused wherever the same shape appears)
|
|
2524
|
+
* Items to estimate tax for
|
|
2525
|
+
*
|
|
2526
|
+
* Field `items` of TaxEngineCreateBody
|
|
2527
|
+
*/
|
|
2528
|
+
export interface TaxEngineCreateBodyItemsItem {
|
|
2529
|
+
/** P21 item ID */
|
|
2530
|
+
itemId: string;
|
|
2531
|
+
/** Quantity to tax, defaults to 1 */
|
|
2532
|
+
quantity?: number;
|
|
2533
|
+
/** Unit of measure; defaults to the item's default selling unit */
|
|
2534
|
+
unitOfMeasure?: string | null;
|
|
2535
|
+
/** Unit price to tax; when absent or 0 the price engine prices the item */
|
|
2536
|
+
unitPrice?: number | null;
|
|
2537
|
+
[key: string]: unknown;
|
|
2538
|
+
}
|
|
2539
|
+
/**
|
|
2540
|
+
* Estimate Sales Tax
|
|
2541
|
+
* Request body for POST /tax-engine — MINIMUM fields, extras pass through
|
|
2542
|
+
*
|
|
2543
|
+
* Request body of: api.pricing.taxEngine.create(data)
|
|
2544
|
+
*/
|
|
2545
|
+
export interface TaxEngineCreateBody {
|
|
2546
|
+
/** P21 customer ID used to price items that carry no unitPrice */
|
|
2547
|
+
customerId: number;
|
|
2548
|
+
/** Destination postal code the tax rate is looked up by */
|
|
2549
|
+
postalCode: string;
|
|
2550
|
+
/** Items to estimate tax for */
|
|
2551
|
+
items: TaxEngineCreateBodyItemsItem[];
|
|
2552
|
+
[key: string]: unknown;
|
|
2553
|
+
}
|
|
2554
|
+
/**
|
|
2555
|
+
* List Tax Groups
|
|
2556
|
+
* Response data for GET /tax-group-hdr — MINIMUM fields, extras pass through
|
|
2557
|
+
*
|
|
2558
|
+
* Returned by: api.pricing.taxGroupHdr.list(params) (array items)
|
|
2559
|
+
*/
|
|
2560
|
+
export interface TaxGroupHdrListItem {
|
|
2561
|
+
/** P21 tax group ID (max 10 chars) */
|
|
2562
|
+
taxGroupId: string;
|
|
2563
|
+
/** P21 company ID (max 8 chars) */
|
|
2564
|
+
companyId: string;
|
|
2565
|
+
/** Tax group description (max 40 chars) */
|
|
2566
|
+
taxGroupDescription: string;
|
|
2567
|
+
/** Y when P21 marks the row deleted (max 1 chars) */
|
|
2568
|
+
deleteFlag: string;
|
|
2569
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2570
|
+
dateCreated: string;
|
|
2571
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2572
|
+
dateLastModified: string;
|
|
2573
|
+
/** P21 user who last changed the row (max 30 chars) */
|
|
2574
|
+
lastMaintainedBy: string;
|
|
2575
|
+
/** P21 override_fc_tax_flag on the tax group (max 1 chars) */
|
|
2576
|
+
overrideFcTaxFlag: string;
|
|
2577
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
2578
|
+
updateCd: number;
|
|
2579
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
2580
|
+
processCd: number;
|
|
2581
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
2582
|
+
statusCd: number;
|
|
2583
|
+
[key: string]: unknown;
|
|
2584
|
+
}
|
|
2585
|
+
/** Returned by: api.pricing.taxGroupHdr.list(params) */
|
|
2586
|
+
export type TaxGroupHdrListData = TaxGroupHdrListItem[];
|
|
2587
|
+
/**
|
|
2588
|
+
* List Tax Group Postal Code Rows
|
|
2589
|
+
* Response data for GET /tax-group-hdr-zip — MINIMUM fields, extras pass through
|
|
2590
|
+
*
|
|
2591
|
+
* Returned by: api.pricing.taxGroupHdrZip.list(params) (array items)
|
|
2592
|
+
* Returned by: api.pricing.taxGroupHdrZip.get(taxGroupHdrZipUid)
|
|
2593
|
+
*/
|
|
2594
|
+
export interface TaxGroupHdrZipListItem {
|
|
2595
|
+
/** Tax group postal code row ID (P21 tax_group_hdr_zip_uid) */
|
|
2596
|
+
taxGroupHdrZipUid: number;
|
|
2597
|
+
/** P21 tax group ID (max 10 chars) */
|
|
2598
|
+
taxGroupId: string;
|
|
2599
|
+
/** P21 company ID (max 8 chars) */
|
|
2600
|
+
companyId: string;
|
|
2601
|
+
/** Start of the zip code range (max 255 chars) */
|
|
2602
|
+
startZipCd: string | null;
|
|
2603
|
+
/** End of the zip code range (max 255 chars) */
|
|
2604
|
+
endZipCd: string | null;
|
|
2605
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2606
|
+
dateCreated: string;
|
|
2607
|
+
/** P21 user who created the row (max 255 chars) */
|
|
2608
|
+
createdBy: string;
|
|
2609
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2610
|
+
dateLastModified: string;
|
|
2611
|
+
/** P21 user who last changed the row (max 255 chars) */
|
|
2612
|
+
lastMaintainedBy: string;
|
|
2613
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
2614
|
+
updateCd: number;
|
|
2615
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
2616
|
+
statusCd: number;
|
|
2617
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
2618
|
+
processCd: number;
|
|
2619
|
+
/** Start of the zip code range as a number */
|
|
2620
|
+
startZipFlt: number | null;
|
|
2621
|
+
/** End of the zip code range as a number */
|
|
2622
|
+
endZipFlt: number | null;
|
|
2623
|
+
[key: string]: unknown;
|
|
2624
|
+
}
|
|
2625
|
+
/** Returned by: api.pricing.taxGroupHdrZip.list(params) */
|
|
2626
|
+
export type TaxGroupHdrZipListData = TaxGroupHdrZipListItem[];
|
|
2627
|
+
/**
|
|
2628
|
+
* Get Tax Group Postal Code Row
|
|
2629
|
+
* Response data for GET /tax-group-hdr-zip/{taxGroupHdrZipUid} — MINIMUM fields, extras pass
|
|
2630
|
+
* through
|
|
2631
|
+
*
|
|
2632
|
+
* Returned by: api.pricing.taxGroupHdrZip.get(taxGroupHdrZipUid)
|
|
2633
|
+
*/
|
|
2634
|
+
export type TaxGroupHdrZipGetData = TaxGroupHdrZipListItem;
|
|
2635
|
+
/**
|
|
2636
|
+
* List Tax Group Lines
|
|
2637
|
+
* Response data for GET /tax-group-line — MINIMUM fields, extras pass through
|
|
2638
|
+
*
|
|
2639
|
+
* Returned by: api.pricing.taxGroupLine.list(params) (array items)
|
|
2640
|
+
*/
|
|
2641
|
+
export interface TaxGroupLineListItem {
|
|
2642
|
+
/** P21 tax group ID (max 10 chars) */
|
|
2643
|
+
taxGroupId: string;
|
|
2644
|
+
/** P21 company ID (max 8 chars) */
|
|
2645
|
+
companyId: string;
|
|
2646
|
+
/** P21 tax jurisdiction ID (tax_jurisdiction.jurisdiction_id) (max 10 chars) */
|
|
2647
|
+
jurisdictionId: string;
|
|
2648
|
+
/** Y when P21 marks the row deleted (max 1 chars) */
|
|
2649
|
+
deleteFlag: string;
|
|
2650
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2651
|
+
dateCreated: string;
|
|
2652
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2653
|
+
dateLastModified: string;
|
|
2654
|
+
/** P21 user who last changed the row (max 30 chars) */
|
|
2655
|
+
lastMaintainedBy: string;
|
|
2656
|
+
/** P21 taxable flag for the jurisdiction on the tax group (max 1 chars) */
|
|
2657
|
+
taxable: string | null;
|
|
2658
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
2659
|
+
updateCd: number;
|
|
2660
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
2661
|
+
processCd: number;
|
|
2662
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
2663
|
+
statusCd: number;
|
|
2664
|
+
[key: string]: unknown;
|
|
2665
|
+
}
|
|
2666
|
+
/** Returned by: api.pricing.taxGroupLine.list(params) */
|
|
2667
|
+
export type TaxGroupLineListData = TaxGroupLineListItem[];
|
|
2668
|
+
/**
|
|
2669
|
+
* List Tax Jurisdictions
|
|
2670
|
+
* Response data for GET /tax-jurisdiction — MINIMUM fields, extras pass through
|
|
2671
|
+
*
|
|
2672
|
+
* Returned by: api.pricing.taxJurisdiction.list(params) (array items)
|
|
2673
|
+
* Returned by: api.pricing.taxJurisdiction.get(jurisdictionId)
|
|
2674
|
+
*/
|
|
2675
|
+
export interface TaxJurisdictionListItem {
|
|
2676
|
+
/** P21 tax jurisdiction ID (tax_jurisdiction.jurisdiction_id) (max 10 chars) */
|
|
2677
|
+
jurisdictionId: string;
|
|
2678
|
+
/** Tax jurisdiction description (max 40 chars) */
|
|
2679
|
+
jurisdictionDesc: string;
|
|
2680
|
+
/** Tax percentage */
|
|
2681
|
+
taxPercentage: number;
|
|
2682
|
+
/** Y when P21 marks the row deleted (max 1 chars) */
|
|
2683
|
+
deleteFlag: string;
|
|
2684
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2685
|
+
dateCreated: string;
|
|
2686
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2687
|
+
dateLastModified: string;
|
|
2688
|
+
/** P21 user who last changed the row (max 30 chars) */
|
|
2689
|
+
lastMaintainedBy: string;
|
|
2690
|
+
/** P21 line item limit */
|
|
2691
|
+
lineItemLimit: number | null;
|
|
2692
|
+
/** P21 invoice limit */
|
|
2693
|
+
invoiceLimit: number | null;
|
|
2694
|
+
/** P21 freight_in_taxable flag (max 1 chars) */
|
|
2695
|
+
freightInTaxable: string | null;
|
|
2696
|
+
/** P21 freight_out_taxable flag (max 1 chars) */
|
|
2697
|
+
freightOutTaxable: string | null;
|
|
2698
|
+
/** P21 tax_is_taxable flag (max 1 chars) */
|
|
2699
|
+
taxIsTaxable: string;
|
|
2700
|
+
/** P21 tax amount per unit */
|
|
2701
|
+
taxAmountPerUnit: number | null;
|
|
2702
|
+
/** P21 unit of measure (max 8 chars) */
|
|
2703
|
+
unitOfMeasure: string | null;
|
|
2704
|
+
/** P21 after_units */
|
|
2705
|
+
afterUnits: number | null;
|
|
2706
|
+
/** P21 after_maximum_units */
|
|
2707
|
+
afterMaximumUnits: number | null;
|
|
2708
|
+
/** P21 see_schedule (max 1 chars) */
|
|
2709
|
+
seeSchedule: string | null;
|
|
2710
|
+
/** P21 tax_on_gross_net_qty_invoiced (max 1 chars) */
|
|
2711
|
+
taxOnGrossNetQtyInvoiced: string | null;
|
|
2712
|
+
/** P21 calculate_tax_method (max 1 chars) */
|
|
2713
|
+
calculateTaxMethod: string;
|
|
2714
|
+
/** P21 line_item_limit_or_range (max 1 chars) */
|
|
2715
|
+
lineItemLimitOrRange: string;
|
|
2716
|
+
/** P21 minimum line item range */
|
|
2717
|
+
minLineItemRange: number | null;
|
|
2718
|
+
/** P21 maximum line item range */
|
|
2719
|
+
maxLineItemRange: number | null;
|
|
2720
|
+
/** P21 incoming_freight (max 1 chars) */
|
|
2721
|
+
incomingFreight: string;
|
|
2722
|
+
/** P21 outgoing_freight (max 1 chars) */
|
|
2723
|
+
outgoingFreight: string;
|
|
2724
|
+
/** P21 tax_terms_taken_flag (max 1 chars) */
|
|
2725
|
+
taxTermsTakenFlag: string;
|
|
2726
|
+
/** P21 report code ID */
|
|
2727
|
+
reportCodeUid: number | null;
|
|
2728
|
+
/** P21 other_charge_freight_taxable (max 1 chars) */
|
|
2729
|
+
otherChargeFreightTaxable: string | null;
|
|
2730
|
+
/** P21 tax_before_after_restock_fee (max 255 chars) */
|
|
2731
|
+
taxBeforeAfterRestockFee: string | null;
|
|
2732
|
+
/** P21 order limit */
|
|
2733
|
+
orderLimit: number | null;
|
|
2734
|
+
/** P21 vat_flag (max 1 chars) */
|
|
2735
|
+
vatFlag: string | null;
|
|
2736
|
+
/** P21 eco_fees_taxable_flag (max 1 chars) */
|
|
2737
|
+
ecoFeesTaxableFlag: string;
|
|
2738
|
+
/** P21 freight_iva_withheld_flag (max 1 chars) */
|
|
2739
|
+
freightIvaWithheldFlag: string;
|
|
2740
|
+
/** P21 jurisdiction tax type code */
|
|
2741
|
+
jurisdictionTaxTypeCd: number | null;
|
|
2742
|
+
/** P21 rental_flag (max 1 chars) */
|
|
2743
|
+
rentalFlag: string | null;
|
|
2744
|
+
/** P21 flat fee amount */
|
|
2745
|
+
flatFeeAmount: number;
|
|
2746
|
+
/** P21 apply_flat_fee_to_linked_rma_flag (max 1 chars) */
|
|
2747
|
+
applyFlatFeeToLinkedRmaFlag: string;
|
|
2748
|
+
/** P21 ioss_flag (max 1 chars) */
|
|
2749
|
+
iossFlag: string;
|
|
2750
|
+
/** P21 IOSS limit type code */
|
|
2751
|
+
iossLimitTypeCd: number | null;
|
|
2752
|
+
/** P21 IOSS limit amount */
|
|
2753
|
+
iossLimitAmount: number | null;
|
|
2754
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
2755
|
+
updateCd: number;
|
|
2756
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
2757
|
+
processCd: number;
|
|
2758
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
2759
|
+
statusCd: number;
|
|
2760
|
+
[key: string]: unknown;
|
|
2761
|
+
}
|
|
2762
|
+
/** Returned by: api.pricing.taxJurisdiction.list(params) */
|
|
2763
|
+
export type TaxJurisdictionListData = TaxJurisdictionListItem[];
|
|
2764
|
+
/**
|
|
2765
|
+
* Get Tax Jurisdiction
|
|
2766
|
+
* Response data for GET /tax-jurisdiction/{jurisdictionId} — MINIMUM fields, extras pass through
|
|
2767
|
+
*
|
|
2768
|
+
* Returned by: api.pricing.taxJurisdiction.get(jurisdictionId)
|
|
2769
|
+
*/
|
|
2770
|
+
export type TaxJurisdictionGetData = TaxJurisdictionListItem;
|
|
2771
|
+
/**
|
|
2772
|
+
* List Web Pricing Rules
|
|
2773
|
+
* Response data for GET /web-pricing — MINIMUM fields, extras pass through
|
|
2774
|
+
*
|
|
2775
|
+
* Returned by: api.pricing.webPricing.list(params) (array items)
|
|
2776
|
+
* Returned by: api.pricing.webPricing.create(data)
|
|
2777
|
+
* Returned by: api.pricing.webPricing.get(webPricingUid)
|
|
2778
|
+
* Returned by: api.pricing.webPricing.update(webPricingUid, data)
|
|
2779
|
+
* Returned by: api.pricing.webPricing.delete(webPricingUid)
|
|
2780
|
+
*/
|
|
2781
|
+
export interface WebPricingListItem {
|
|
2782
|
+
/** Web pricing rule unique ID */
|
|
2783
|
+
webPricingUid: number;
|
|
2784
|
+
/** Rule name shown to staff (max 255 chars) */
|
|
2785
|
+
name: string;
|
|
2786
|
+
/** Optional free-text note about the rule (max 255 chars) */
|
|
2787
|
+
description: string | null;
|
|
2788
|
+
/** When the rule was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2789
|
+
dateCreated: string;
|
|
2790
|
+
/** When the rule was last changed (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2791
|
+
dateLastModified: string;
|
|
2792
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted); only active rules apply */
|
|
2793
|
+
statusCd: number;
|
|
2794
|
+
/** Update code */
|
|
2795
|
+
updateCd: number;
|
|
2796
|
+
/** Process code */
|
|
2797
|
+
processCd: number;
|
|
2798
|
+
/** Evaluation order, ascending; the first matching rule wins */
|
|
2799
|
+
sequenceNo: number;
|
|
2800
|
+
/**
|
|
2801
|
+
* Which customers the rule applies to: NONE or ALL (every customer), ONLY (listed customers),
|
|
2802
|
+
* EXCEPT (everyone not listed) (max 255 chars)
|
|
2803
|
+
*/
|
|
2804
|
+
customerMode: string;
|
|
2805
|
+
/** Minimum cart quantity for the rule to match; 0 or less means no lower bound */
|
|
2806
|
+
minQty: number | null;
|
|
2807
|
+
/** Maximum cart quantity for the rule to match; 0 or less means no upper bound */
|
|
2808
|
+
maxQty: number | null;
|
|
2809
|
+
/** Percentage taken off the engine unit price (above 0, at most 100) */
|
|
2810
|
+
discountPct: number;
|
|
2811
|
+
/** Start of the window the rule applies in (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2812
|
+
effectiveDate: string | null;
|
|
2813
|
+
/** End of the window the rule applies in (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2814
|
+
expirationDate: string | null;
|
|
2815
|
+
[key: string]: unknown;
|
|
2816
|
+
}
|
|
2817
|
+
/** Returned by: api.pricing.webPricing.list(params) */
|
|
2818
|
+
export type WebPricingListData = WebPricingListItem[];
|
|
2819
|
+
/**
|
|
2820
|
+
* Create Web Pricing Rule
|
|
2821
|
+
* Response data for POST /web-pricing — MINIMUM fields, extras pass through
|
|
2822
|
+
*
|
|
2823
|
+
* Returned by: api.pricing.webPricing.create(data)
|
|
2824
|
+
*/
|
|
2825
|
+
export type WebPricingCreateData = WebPricingListItem;
|
|
2826
|
+
/**
|
|
2827
|
+
* Create Web Pricing Rule
|
|
2828
|
+
* Request body for POST /web-pricing — MINIMUM fields, extras pass through
|
|
2829
|
+
*
|
|
2830
|
+
* Request body of: api.pricing.webPricing.create(data)
|
|
2831
|
+
*/
|
|
2832
|
+
export interface WebPricingCreateBody {
|
|
2833
|
+
/** Rule name; required and MUST NOT be empty (max 255 chars) */
|
|
2834
|
+
name: string | null;
|
|
2835
|
+
/** Percentage taken off the engine unit price; required, above 0 and at most 100 */
|
|
2836
|
+
discountPct: number | null;
|
|
2837
|
+
/** Optional free-text note about the rule (max 255 chars) */
|
|
2838
|
+
description?: string | null;
|
|
2839
|
+
/** Evaluation order, ascending; the first matching rule wins (Default: 1) */
|
|
2840
|
+
sequenceNo?: number | null;
|
|
2841
|
+
/**
|
|
2842
|
+
* Which customers the rule applies to: NONE, ALL, ONLY or EXCEPT (Default: NONE) (max 255 chars)
|
|
2843
|
+
*/
|
|
2844
|
+
customerMode?: string | null;
|
|
2845
|
+
/** Minimum cart quantity; 0 or less means no lower bound (Default: -1) */
|
|
2846
|
+
minQty?: number | null;
|
|
2847
|
+
/**
|
|
2848
|
+
* Maximum cart quantity; 0 or less means no upper bound, and MUST NOT be below minQty (Default:
|
|
2849
|
+
* -1)
|
|
2850
|
+
*/
|
|
2851
|
+
maxQty?: number | null;
|
|
2852
|
+
/** Start of the window the rule applies in (Default: now) */
|
|
2853
|
+
effectiveDate?: string | null;
|
|
2854
|
+
/**
|
|
2855
|
+
* End of the window the rule applies in; MUST NOT be before effectiveDate (Default: 2049-12-31)
|
|
2856
|
+
*/
|
|
2857
|
+
expirationDate?: string | null;
|
|
2858
|
+
[key: string]: unknown;
|
|
2859
|
+
}
|
|
2860
|
+
/**
|
|
2861
|
+
* Get Web Pricing Rule
|
|
2862
|
+
* Response data for GET /web-pricing/{webPricingUid} — MINIMUM fields, extras pass through
|
|
2863
|
+
*
|
|
2864
|
+
* Returned by: api.pricing.webPricing.get(webPricingUid)
|
|
2865
|
+
*/
|
|
2866
|
+
export type WebPricingGetData = WebPricingListItem;
|
|
2867
|
+
/**
|
|
2868
|
+
* Update Web Pricing Rule
|
|
2869
|
+
* Response data for PUT /web-pricing/{webPricingUid} — MINIMUM fields, extras pass through
|
|
2870
|
+
*
|
|
2871
|
+
* Returned by: api.pricing.webPricing.update(webPricingUid, data)
|
|
2872
|
+
*/
|
|
2873
|
+
export type WebPricingUpdateData = WebPricingListItem;
|
|
2874
|
+
/**
|
|
2875
|
+
* Update Web Pricing Rule
|
|
2876
|
+
* Request body for PUT /web-pricing/{webPricingUid} — MINIMUM fields, extras pass through
|
|
2877
|
+
*
|
|
2878
|
+
* Request body of: api.pricing.webPricing.update(webPricingUid, data)
|
|
2879
|
+
*/
|
|
2880
|
+
export interface WebPricingUpdateBody {
|
|
2881
|
+
/** Rule name; MUST NOT be empty when sent (max 255 chars) */
|
|
2882
|
+
name?: string | null;
|
|
2883
|
+
/** Free-text note about the rule; sending null clears it (max 255 chars) */
|
|
2884
|
+
description?: string | null;
|
|
2885
|
+
/** Evaluation order, ascending; the first matching rule wins */
|
|
2886
|
+
sequenceNo?: number | null;
|
|
2887
|
+
/** Which customers the rule applies to: NONE, ALL, ONLY or EXCEPT (max 255 chars) */
|
|
2888
|
+
customerMode?: string | null;
|
|
2889
|
+
/** Minimum cart quantity; 0 or less means no lower bound */
|
|
2890
|
+
minQty?: number | null;
|
|
2891
|
+
/** Maximum cart quantity; 0 or less means no upper bound, and MUST NOT be below minQty */
|
|
2892
|
+
maxQty?: number | null;
|
|
2893
|
+
/** Percentage taken off the engine unit price; above 0 and at most 100 */
|
|
2894
|
+
discountPct?: number | null;
|
|
2895
|
+
/** Start of the window the rule applies in */
|
|
2896
|
+
effectiveDate?: string | null;
|
|
2897
|
+
/** End of the window the rule applies in; MUST NOT be before effectiveDate */
|
|
2898
|
+
expirationDate?: string | null;
|
|
2899
|
+
/** Status code: 704 (Active), 705 (Inactive) or 700 (Deleted) */
|
|
2900
|
+
statusCd?: number | null;
|
|
2901
|
+
[key: string]: unknown;
|
|
2902
|
+
}
|
|
2903
|
+
/**
|
|
2904
|
+
* Soft Delete Web Pricing Rule
|
|
2905
|
+
* Response data for DELETE /web-pricing/{webPricingUid} — MINIMUM fields, extras pass through
|
|
2906
|
+
*
|
|
2907
|
+
* Returned by: api.pricing.webPricing.delete(webPricingUid)
|
|
2908
|
+
*/
|
|
2909
|
+
export type WebPricingDeleteData = WebPricingListItem;
|
|
2910
|
+
/**
|
|
2911
|
+
* List Web Pricing Customers
|
|
2912
|
+
* Response data for GET /web-pricing/{webPricingUid}/customers — MINIMUM fields, extras pass
|
|
2913
|
+
* through
|
|
2914
|
+
*
|
|
2915
|
+
* Returned by: api.pricing.webPricing.customers.list(webPricingUid, params) (array items)
|
|
2916
|
+
* Returned by: api.pricing.webPricing.customers.create(webPricingUid, data)
|
|
2917
|
+
* Returned by: api.pricing.webPricing.customers.get(webPricingUid, customerId)
|
|
2918
|
+
* Returned by: api.pricing.webPricing.customers.update(webPricingUid, customerId, data)
|
|
2919
|
+
* Returned by: api.pricing.webPricing.customers.delete(webPricingUid, customerId)
|
|
2920
|
+
*/
|
|
2921
|
+
export interface WebPricingCustomersListItem {
|
|
2922
|
+
/** Customer assignment unique ID */
|
|
2923
|
+
webPricingXCustomerUid: number;
|
|
2924
|
+
/** Web pricing rule the customer is assigned to */
|
|
2925
|
+
webPricingUid: number;
|
|
2926
|
+
/** Prophet 21 customer assigned to the rule */
|
|
2927
|
+
customerId: number;
|
|
2928
|
+
/** When the assignment was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2929
|
+
dateCreated: string;
|
|
2930
|
+
/** When the assignment was last changed (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2931
|
+
dateLastModified: string;
|
|
2932
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted); only active assignments count */
|
|
2933
|
+
statusCd: number;
|
|
2934
|
+
/** Update code */
|
|
2935
|
+
updateCd: number;
|
|
2936
|
+
/** Process code */
|
|
2937
|
+
processCd: number;
|
|
2938
|
+
[key: string]: unknown;
|
|
2939
|
+
}
|
|
2940
|
+
/** Returned by: api.pricing.webPricing.customers.list(webPricingUid, params) */
|
|
2941
|
+
export type WebPricingCustomersListData = WebPricingCustomersListItem[];
|
|
2942
|
+
/**
|
|
2943
|
+
* Assign Web Pricing Customer
|
|
2944
|
+
* Response data for POST /web-pricing/{webPricingUid}/customers — MINIMUM fields, extras pass
|
|
2945
|
+
* through
|
|
2946
|
+
*
|
|
2947
|
+
* Returned by: api.pricing.webPricing.customers.create(webPricingUid, data)
|
|
2948
|
+
*/
|
|
2949
|
+
export type WebPricingCustomersCreateData = WebPricingCustomersListItem;
|
|
2950
|
+
/**
|
|
2951
|
+
* Assign Web Pricing Customer
|
|
2952
|
+
* Request body for POST /web-pricing/{webPricingUid}/customers — MINIMUM fields, extras pass
|
|
2953
|
+
* through
|
|
2954
|
+
*
|
|
2955
|
+
* Request body of: api.pricing.webPricing.customers.create(webPricingUid, data)
|
|
2956
|
+
*/
|
|
2957
|
+
export interface WebPricingCustomersCreateBody {
|
|
2958
|
+
/** Prophet 21 customer to assign; required, a positive integer */
|
|
2959
|
+
customerId: number | null;
|
|
2960
|
+
[key: string]: unknown;
|
|
2961
|
+
}
|
|
2962
|
+
/**
|
|
2963
|
+
* Get Web Pricing Customer
|
|
2964
|
+
* Response data for GET /web-pricing/{webPricingUid}/customers/{customerId} — MINIMUM fields,
|
|
2965
|
+
* extras pass through
|
|
2966
|
+
*
|
|
2967
|
+
* Returned by: api.pricing.webPricing.customers.get(webPricingUid, customerId)
|
|
2968
|
+
*/
|
|
2969
|
+
export type WebPricingCustomersGetData = WebPricingCustomersListItem;
|
|
2970
|
+
/**
|
|
2971
|
+
* Update Web Pricing Customer
|
|
2972
|
+
* Response data for PUT /web-pricing/{webPricingUid}/customers/{customerId} — MINIMUM fields,
|
|
2973
|
+
* extras pass through
|
|
2974
|
+
*
|
|
2975
|
+
* Returned by: api.pricing.webPricing.customers.update(webPricingUid, customerId, data)
|
|
2976
|
+
*/
|
|
2977
|
+
export type WebPricingCustomersUpdateData = WebPricingCustomersListItem;
|
|
2978
|
+
/**
|
|
2979
|
+
* Update Web Pricing Customer
|
|
2980
|
+
* Request body for PUT /web-pricing/{webPricingUid}/customers/{customerId} — MINIMUM fields, extras
|
|
2981
|
+
* pass through
|
|
2982
|
+
*
|
|
2983
|
+
* Request body of: api.pricing.webPricing.customers.update(webPricingUid, customerId, data)
|
|
2984
|
+
*/
|
|
2985
|
+
export interface WebPricingCustomersUpdateBody {
|
|
2986
|
+
/** Status code: 704 (Active), 705 (Inactive) or 700 (Deleted); only active assignments count */
|
|
2987
|
+
statusCd?: number | null;
|
|
2988
|
+
[key: string]: unknown;
|
|
2989
|
+
}
|
|
2990
|
+
/**
|
|
2991
|
+
* Remove Web Pricing Customer
|
|
2992
|
+
* Response data for DELETE /web-pricing/{webPricingUid}/customers/{customerId} — MINIMUM fields,
|
|
2993
|
+
* extras pass through
|
|
2994
|
+
*
|
|
2995
|
+
* Returned by: api.pricing.webPricing.customers.delete(webPricingUid, customerId)
|
|
2996
|
+
*/
|
|
2997
|
+
export type WebPricingCustomersDeleteData = WebPricingCustomersListItem;
|
|
2998
|
+
export interface PricingClientSpec {
|
|
2999
|
+
jobPriceBin: {
|
|
3000
|
+
/**
|
|
3001
|
+
* List Job Price Bins
|
|
3002
|
+
* Call: api.pricing.jobPriceBin.list(params)
|
|
3003
|
+
*
|
|
3004
|
+
* List job price bins as Augur holds them locally
|
|
3005
|
+
*
|
|
3006
|
+
* Errors:
|
|
3007
|
+
* 400: JobPriceLineUid or customerId or shipToId is not a number, or orderBy is not one
|
|
3008
|
+
* job_price_bin column with ASC or DESC.
|
|
3009
|
+
*
|
|
3010
|
+
* GET https://pricing.augur-api.com/job-price-bin
|
|
3011
|
+
* Contract: https://pricing.augur-api.com/openapi.json#/paths/~1job-price-bin/get
|
|
3012
|
+
*
|
|
3013
|
+
* @param params JobPriceBinListParams (query string)
|
|
3014
|
+
* @returns BaseResponse whose `data` is JobPriceBinListData
|
|
3015
|
+
*/
|
|
3016
|
+
list: (params?: JobPriceBinListParams) => Promise<BaseResponse<JobPriceBinListData>>;
|
|
3017
|
+
/**
|
|
3018
|
+
* Get Job Price Bin
|
|
3019
|
+
* Call: api.pricing.jobPriceBin.get(jobPriceBinUid)
|
|
3020
|
+
*
|
|
3021
|
+
* Get one job price bin as Augur holds it locally
|
|
3022
|
+
*
|
|
3023
|
+
* Errors:
|
|
3024
|
+
* 404: No job price bin with this jobPriceBinUid.
|
|
3025
|
+
*
|
|
3026
|
+
* GET https://pricing.augur-api.com/job-price-bin/{jobPriceBinUid}
|
|
3027
|
+
* Contract:
|
|
3028
|
+
* https://pricing.augur-api.com/openapi.json#/paths/~1job-price-bin~1{jobPriceBinUid}/get
|
|
3029
|
+
*
|
|
3030
|
+
* @param jobPriceBinUid Job price bin ID (job_price_bin.job_price_bin_uid)
|
|
3031
|
+
* @param params JobPriceBinGetParams (query string)
|
|
3032
|
+
* @returns BaseResponse whose `data` is JobPriceBinGetData
|
|
3033
|
+
*/
|
|
3034
|
+
get: (jobPriceBinUid: number, params?: JobPriceBinGetParams) => Promise<BaseResponse<JobPriceBinGetData>>;
|
|
3035
|
+
};
|
|
3036
|
+
jobPriceCustomerShipto: {
|
|
3037
|
+
/**
|
|
3038
|
+
* List Job Price Customer Ship-to Rows
|
|
3039
|
+
* Call: api.pricing.jobPriceCustomerShipto.list(params)
|
|
3040
|
+
*
|
|
3041
|
+
* List job price customer ship-to rows as Augur holds them locally
|
|
3042
|
+
*
|
|
3043
|
+
* Errors:
|
|
3044
|
+
* 400: JobPriceHdrUid or customerId or shipToId is not a number, or orderBy is not one
|
|
3045
|
+
* job_price_customer_shipto column with ASC or DESC.
|
|
3046
|
+
*
|
|
3047
|
+
* GET https://pricing.augur-api.com/job-price-customer-shipto
|
|
3048
|
+
* Contract: https://pricing.augur-api.com/openapi.json#/paths/~1job-price-customer-shipto/get
|
|
3049
|
+
*
|
|
3050
|
+
* @param params JobPriceCustomerShiptoListParams (query string)
|
|
3051
|
+
* @returns BaseResponse whose `data` is JobPriceCustomerShiptoListData
|
|
3052
|
+
*/
|
|
3053
|
+
list: (params?: JobPriceCustomerShiptoListParams) => Promise<BaseResponse<JobPriceCustomerShiptoListData>>;
|
|
3054
|
+
/**
|
|
3055
|
+
* Get Job Price Customer Ship-to Row
|
|
3056
|
+
* Call: api.pricing.jobPriceCustomerShipto.get(jobPriceCustShiptoUid)
|
|
3057
|
+
*
|
|
3058
|
+
* Get one job price customer ship-to row as Augur holds it locally
|
|
3059
|
+
*
|
|
3060
|
+
* Errors:
|
|
3061
|
+
* 404: No job price customer ship-to row with this jobPriceCustShiptoUid.
|
|
3062
|
+
*
|
|
3063
|
+
* GET https://pricing.augur-api.com/job-price-customer-shipto/{jobPriceCustShiptoUid}
|
|
3064
|
+
* Contract:
|
|
3065
|
+
* https://pricing.augur-api.com/openapi.json#/paths/~1job-price-customer-shipto~1{jobPriceCustShiptoUid}/get
|
|
3066
|
+
*
|
|
3067
|
+
* @param jobPriceCustShiptoUid Job price customer ship-to row ID
|
|
3068
|
+
* (job_price_customer_shipto.job_price_cust_shipto_uid)
|
|
3069
|
+
* @param params JobPriceCustomerShiptoGetParams (query string)
|
|
3070
|
+
* @returns BaseResponse whose `data` is JobPriceCustomerShiptoGetData
|
|
3071
|
+
*/
|
|
3072
|
+
get: (jobPriceCustShiptoUid: number, params?: JobPriceCustomerShiptoGetParams) => Promise<BaseResponse<JobPriceCustomerShiptoGetData>>;
|
|
3073
|
+
};
|
|
3074
|
+
jobPriceHdr: {
|
|
3075
|
+
/**
|
|
3076
|
+
* List Job Price Hdrs
|
|
3077
|
+
* Call: api.pricing.jobPriceHdr.list(params)
|
|
3078
|
+
*
|
|
3079
|
+
* List Job Price Headers
|
|
3080
|
+
*
|
|
3081
|
+
* Errors:
|
|
3082
|
+
* 400: Invalid orderBy: not one job price header column with ASC or DESC; message says which.
|
|
3083
|
+
*
|
|
3084
|
+
* GET https://pricing.augur-api.com/job-price-hdr
|
|
3085
|
+
* Contract: https://pricing.augur-api.com/openapi.json#/paths/~1job-price-hdr/get
|
|
3086
|
+
*
|
|
3087
|
+
* @param params JobPriceHdrListParams (query string)
|
|
3088
|
+
* @returns BaseResponse whose `data` is JobPriceHdrListData
|
|
3089
|
+
*/
|
|
3090
|
+
list: (params?: JobPriceHdrListParams) => Promise<BaseResponse<JobPriceHdrListData>>;
|
|
3091
|
+
/**
|
|
3092
|
+
* Get Job Price Header Details
|
|
3093
|
+
* Call: api.pricing.jobPriceHdr.get(jobPriceHdrUid)
|
|
3094
|
+
*
|
|
3095
|
+
* Errors:
|
|
3096
|
+
* 404: No job price header with this ID.
|
|
3097
|
+
*
|
|
3098
|
+
* GET https://pricing.augur-api.com/job-price-hdr/{jobPriceHdrUid}
|
|
3099
|
+
* Contract:
|
|
3100
|
+
* https://pricing.augur-api.com/openapi.json#/paths/~1job-price-hdr~1{jobPriceHdrUid}/get
|
|
3101
|
+
*
|
|
3102
|
+
* @param jobPriceHdrUid Job price header unique ID to return
|
|
3103
|
+
* @param params JobPriceHdrGetParams (query string)
|
|
3104
|
+
* @returns BaseResponse whose `data` is JobPriceHdrGetData
|
|
3105
|
+
*/
|
|
3106
|
+
get: (jobPriceHdrUid: number, params?: JobPriceHdrGetParams) => Promise<BaseResponse<JobPriceHdrGetData>>;
|
|
3107
|
+
lines: {
|
|
3108
|
+
/**
|
|
3109
|
+
* List Job Price Lines
|
|
3110
|
+
* Call: api.pricing.jobPriceHdr.lines.list(jobPriceHdrUid, params)
|
|
3111
|
+
*
|
|
3112
|
+
* Errors:
|
|
3113
|
+
* 400: Invalid orderBy: not one job price line column with ASC or DESC; message says which.
|
|
3114
|
+
* 404: No job_price_hdr row with this jobPriceHdrUid.
|
|
3115
|
+
*
|
|
3116
|
+
* GET https://pricing.augur-api.com/job-price-hdr/{jobPriceHdrUid}/lines
|
|
3117
|
+
* Contract:
|
|
3118
|
+
* https://pricing.augur-api.com/openapi.json#/paths/~1job-price-hdr~1{jobPriceHdrUid}~1lines/get
|
|
3119
|
+
*
|
|
3120
|
+
* @param jobPriceHdrUid Job Price Header UID
|
|
3121
|
+
* @param params JobPriceHdrLinesListParams (query string)
|
|
3122
|
+
* @returns BaseResponse whose `data` is JobPriceHdrLinesListData
|
|
3123
|
+
*/
|
|
3124
|
+
list: (jobPriceHdrUid: number, params?: JobPriceHdrLinesListParams) => Promise<BaseResponse<JobPriceHdrLinesListData>>;
|
|
3125
|
+
/**
|
|
3126
|
+
* Get Job Price Line Details
|
|
3127
|
+
* Call: api.pricing.jobPriceHdr.lines.get(jobPriceHdrUid, jobPriceLineUid)
|
|
3128
|
+
*
|
|
3129
|
+
* Errors:
|
|
3130
|
+
* 404: No job price line with this ID under this job price header.
|
|
3131
|
+
*
|
|
3132
|
+
* GET https://pricing.augur-api.com/job-price-hdr/{jobPriceHdrUid}/lines/{jobPriceLineUid}
|
|
3133
|
+
* Contract:
|
|
3134
|
+
* https://pricing.augur-api.com/openapi.json#/paths/~1job-price-hdr~1{jobPriceHdrUid}~1lines~1{jobPriceLineUid}/get
|
|
3135
|
+
*
|
|
3136
|
+
* @param jobPriceHdrUid Job price header the line belongs to
|
|
3137
|
+
* @param jobPriceLineUid Job price line unique ID to return
|
|
3138
|
+
* @param params JobPriceHdrLinesGetParams (query string)
|
|
3139
|
+
* @returns BaseResponse whose `data` is JobPriceHdrLinesGetData
|
|
3140
|
+
*/
|
|
3141
|
+
get: (jobPriceHdrUid: number, jobPriceLineUid: number, params?: JobPriceHdrLinesGetParams) => Promise<BaseResponse<JobPriceHdrLinesGetData>>;
|
|
3142
|
+
};
|
|
3143
|
+
};
|
|
3144
|
+
priceBook: {
|
|
3145
|
+
/**
|
|
3146
|
+
* List Price Books
|
|
3147
|
+
* Call: api.pricing.priceBook.list(params)
|
|
3148
|
+
*
|
|
3149
|
+
* List price books as Augur holds them locally
|
|
3150
|
+
*
|
|
3151
|
+
* Errors:
|
|
3152
|
+
* 400: OrderBy is not one price_book column with ASC or DESC.
|
|
3153
|
+
*
|
|
3154
|
+
* GET https://pricing.augur-api.com/price-book
|
|
3155
|
+
* Contract: https://pricing.augur-api.com/openapi.json#/paths/~1price-book/get
|
|
3156
|
+
*
|
|
3157
|
+
* @param params PriceBookListParams (query string)
|
|
3158
|
+
* @returns BaseResponse whose `data` is PriceBookListData
|
|
3159
|
+
*/
|
|
3160
|
+
list: (params?: PriceBookListParams) => Promise<BaseResponse<PriceBookListData>>;
|
|
3161
|
+
/**
|
|
3162
|
+
* Get Price Book
|
|
3163
|
+
* Call: api.pricing.priceBook.get(priceBookUid)
|
|
3164
|
+
*
|
|
3165
|
+
* Get one price book as Augur holds it locally
|
|
3166
|
+
*
|
|
3167
|
+
* Errors:
|
|
3168
|
+
* 404: No price book with this priceBookUid.
|
|
3169
|
+
*
|
|
3170
|
+
* GET https://pricing.augur-api.com/price-book/{priceBookUid}
|
|
3171
|
+
* Contract: https://pricing.augur-api.com/openapi.json#/paths/~1price-book~1{priceBookUid}/get
|
|
3172
|
+
*
|
|
3173
|
+
* @param priceBookUid Price book ID (price_book.price_book_uid)
|
|
3174
|
+
* @param params PriceBookGetParams (query string)
|
|
3175
|
+
* @returns BaseResponse whose `data` is PriceBookGetData
|
|
3176
|
+
*/
|
|
3177
|
+
get: (priceBookUid: number, params?: PriceBookGetParams) => Promise<BaseResponse<PriceBookGetData>>;
|
|
3178
|
+
};
|
|
3179
|
+
priceBookXLibrary: {
|
|
3180
|
+
/**
|
|
3181
|
+
* List Price Book To Library Links
|
|
3182
|
+
* Call: api.pricing.priceBookXLibrary.list(params)
|
|
3183
|
+
*
|
|
3184
|
+
* List price book to library links as Augur holds them locally
|
|
3185
|
+
*
|
|
3186
|
+
* Errors:
|
|
3187
|
+
* 400: PriceLibraryUid or priceBookUid is not a number, or orderBy is not one
|
|
3188
|
+
* price_book_x_library column with ASC or DESC.
|
|
3189
|
+
*
|
|
3190
|
+
* GET https://pricing.augur-api.com/price-book-x-library
|
|
3191
|
+
* Contract: https://pricing.augur-api.com/openapi.json#/paths/~1price-book-x-library/get
|
|
3192
|
+
*
|
|
3193
|
+
* @param params PriceBookXLibraryListParams (query string)
|
|
3194
|
+
* @returns BaseResponse whose `data` is PriceBookXLibraryListData
|
|
3195
|
+
*/
|
|
3196
|
+
list: (params?: PriceBookXLibraryListParams) => Promise<BaseResponse<PriceBookXLibraryListData>>;
|
|
3197
|
+
/**
|
|
3198
|
+
* Get Price Book To Library Link
|
|
3199
|
+
* Call: api.pricing.priceBookXLibrary.get(priceBookXLibraryUid)
|
|
3200
|
+
*
|
|
3201
|
+
* Get one price book to library link as Augur holds it locally
|
|
3202
|
+
*
|
|
3203
|
+
* Errors:
|
|
3204
|
+
* 404: No price book to library link with this priceBookXLibraryUid.
|
|
3205
|
+
*
|
|
3206
|
+
* GET https://pricing.augur-api.com/price-book-x-library/{priceBookXLibraryUid}
|
|
3207
|
+
* Contract:
|
|
3208
|
+
* https://pricing.augur-api.com/openapi.json#/paths/~1price-book-x-library~1{priceBookXLibraryUid}/get
|
|
3209
|
+
*
|
|
3210
|
+
* @param priceBookXLibraryUid Price book to library link ID
|
|
3211
|
+
* (price_book_x_library.price_book_x_library_uid)
|
|
3212
|
+
* @param params PriceBookXLibraryGetParams (query string)
|
|
3213
|
+
* @returns BaseResponse whose `data` is PriceBookXLibraryGetData
|
|
3214
|
+
*/
|
|
3215
|
+
get: (priceBookXLibraryUid: number, params?: PriceBookXLibraryGetParams) => Promise<BaseResponse<PriceBookXLibraryGetData>>;
|
|
3216
|
+
};
|
|
3217
|
+
priceEngine: {
|
|
3218
|
+
/**
|
|
3219
|
+
* Get Item Price
|
|
3220
|
+
* Call: api.pricing.priceEngine.list(params)
|
|
3221
|
+
*
|
|
3222
|
+
* Response data: Price for one item and customer from the four-stage pricing waterfall (job,
|
|
3223
|
+
* source code, library, default company)
|
|
3224
|
+
*
|
|
3225
|
+
* Errors:
|
|
3226
|
+
* 400: A positive "customerId" is required.
|
|
3227
|
+
*
|
|
3228
|
+
* GET https://pricing.augur-api.com/price-engine
|
|
3229
|
+
* Contract: https://pricing.augur-api.com/openapi.json#/paths/~1price-engine/get
|
|
3230
|
+
*
|
|
3231
|
+
* @param params PriceEngineListParams (query string)
|
|
3232
|
+
* @returns BaseResponse whose `data` is PriceEngineListData
|
|
3233
|
+
*/
|
|
3234
|
+
list: (params?: PriceEngineListParams) => Promise<BaseResponse<PriceEngineListData>>;
|
|
3235
|
+
/**
|
|
3236
|
+
* Cart Price Engine
|
|
3237
|
+
* Call: api.pricing.priceEngine.create(data)
|
|
3238
|
+
*
|
|
3239
|
+
* Price multiple items with cart context for group break pricing
|
|
3240
|
+
*
|
|
3241
|
+
* Request body: Cart to price; every line is priced with the whole cart as context for group
|
|
3242
|
+
* quantity breaks
|
|
3243
|
+
* Response data: Prices for every cart line, each priced with the whole cart as context for
|
|
3244
|
+
* group quantity breaks
|
|
3245
|
+
*
|
|
3246
|
+
* Errors:
|
|
3247
|
+
* 400: Request body is required with customerId and items array. Or A required body field is
|
|
3248
|
+
* missing or has the wrong type.
|
|
3249
|
+
*
|
|
3250
|
+
* POST https://pricing.augur-api.com/price-engine
|
|
3251
|
+
* Contract: https://pricing.augur-api.com/openapi.json#/paths/~1price-engine/post
|
|
3252
|
+
*
|
|
3253
|
+
* @param data PriceEngineCreateBody (request body)
|
|
3254
|
+
* @returns BaseResponse whose `data` is PriceEngineCreateData
|
|
3255
|
+
*/
|
|
3256
|
+
create: (data: PriceEngineCreateBody) => Promise<BaseResponse<PriceEngineCreateData>>;
|
|
3257
|
+
};
|
|
3258
|
+
priceFamily: {
|
|
3259
|
+
/**
|
|
3260
|
+
* List Price Families
|
|
3261
|
+
* Call: api.pricing.priceFamily.list(params)
|
|
3262
|
+
*
|
|
3263
|
+
* List price families as Augur holds them locally
|
|
3264
|
+
*
|
|
3265
|
+
* Errors:
|
|
3266
|
+
* 400: OrderBy is not one price_family column with ASC or DESC.
|
|
3267
|
+
*
|
|
3268
|
+
* GET https://pricing.augur-api.com/price-family
|
|
3269
|
+
* Contract: https://pricing.augur-api.com/openapi.json#/paths/~1price-family/get
|
|
3270
|
+
*
|
|
3271
|
+
* @param params PriceFamilyListParams (query string)
|
|
3272
|
+
* @returns BaseResponse whose `data` is PriceFamilyListData
|
|
3273
|
+
*/
|
|
3274
|
+
list: (params?: PriceFamilyListParams) => Promise<BaseResponse<PriceFamilyListData>>;
|
|
3275
|
+
/**
|
|
3276
|
+
* Get Price Family
|
|
3277
|
+
* Call: api.pricing.priceFamily.get(priceFamilyUid)
|
|
3278
|
+
*
|
|
3279
|
+
* Get one price family as Augur holds it locally
|
|
3280
|
+
*
|
|
3281
|
+
* Errors:
|
|
3282
|
+
* 404: No price family with this priceFamilyUid.
|
|
3283
|
+
*
|
|
3284
|
+
* GET https://pricing.augur-api.com/price-family/{priceFamilyUid}
|
|
3285
|
+
* Contract:
|
|
3286
|
+
* https://pricing.augur-api.com/openapi.json#/paths/~1price-family~1{priceFamilyUid}/get
|
|
3287
|
+
*
|
|
3288
|
+
* @param priceFamilyUid Price family ID (price_family.price_family_uid)
|
|
3289
|
+
* @param params PriceFamilyGetParams (query string)
|
|
3290
|
+
* @returns BaseResponse whose `data` is PriceFamilyGetData
|
|
3291
|
+
*/
|
|
3292
|
+
get: (priceFamilyUid: number, params?: PriceFamilyGetParams) => Promise<BaseResponse<PriceFamilyGetData>>;
|
|
3293
|
+
};
|
|
3294
|
+
priceFamilyXRestrictedClass: {
|
|
3295
|
+
/**
|
|
3296
|
+
* List Price Family To Restricted Class Links
|
|
3297
|
+
* Call: api.pricing.priceFamilyXRestrictedClass.list(params)
|
|
3298
|
+
*
|
|
3299
|
+
* List price family to restricted class links as Augur holds them locally
|
|
3300
|
+
*
|
|
3301
|
+
* Errors:
|
|
3302
|
+
* 400: PriceFamilyUid or restrictedClassUid is not a number, or orderBy is not one
|
|
3303
|
+
* price_family_x_restricted_class column with ASC or DESC.
|
|
3304
|
+
*
|
|
3305
|
+
* GET https://pricing.augur-api.com/price-family-x-restricted-class
|
|
3306
|
+
* Contract:
|
|
3307
|
+
* https://pricing.augur-api.com/openapi.json#/paths/~1price-family-x-restricted-class/get
|
|
3308
|
+
*
|
|
3309
|
+
* @param params PriceFamilyXRestrictedClassListParams (query string)
|
|
3310
|
+
* @returns BaseResponse whose `data` is PriceFamilyXRestrictedClassListData
|
|
3311
|
+
*/
|
|
3312
|
+
list: (params?: PriceFamilyXRestrictedClassListParams) => Promise<BaseResponse<PriceFamilyXRestrictedClassListData>>;
|
|
3313
|
+
/**
|
|
3314
|
+
* Get Price Family To Restricted Class Link
|
|
3315
|
+
* Call: api.pricing.priceFamilyXRestrictedClass.get(priceFamilyXRestrictedClassUid)
|
|
3316
|
+
*
|
|
3317
|
+
* Get one price family to restricted class link as Augur holds it locally
|
|
3318
|
+
*
|
|
3319
|
+
* Errors:
|
|
3320
|
+
* 404: No price family to restricted class link with this priceFamilyXRestrictedClassUid.
|
|
3321
|
+
*
|
|
3322
|
+
* GET
|
|
3323
|
+
* https://pricing.augur-api.com/price-family-x-restricted-class/{priceFamilyXRestrictedClassUid}
|
|
3324
|
+
* Contract:
|
|
3325
|
+
* https://pricing.augur-api.com/openapi.json#/paths/~1price-family-x-restricted-class~1{priceFamilyXRestrictedClassUid}/get
|
|
3326
|
+
*
|
|
3327
|
+
* @param priceFamilyXRestrictedClassUid Price family to restricted class link ID
|
|
3328
|
+
* (price_family_x_restricted_class.price_family_x_restricted_class_uid)
|
|
3329
|
+
* @param params PriceFamilyXRestrictedClassGetParams (query string)
|
|
3330
|
+
* @returns BaseResponse whose `data` is PriceFamilyXRestrictedClassGetData
|
|
3331
|
+
*/
|
|
3332
|
+
get: (priceFamilyXRestrictedClassUid: number, params?: PriceFamilyXRestrictedClassGetParams) => Promise<BaseResponse<PriceFamilyXRestrictedClassGetData>>;
|
|
3333
|
+
};
|
|
3334
|
+
priceLibrary: {
|
|
3335
|
+
/**
|
|
3336
|
+
* List Price Libraries
|
|
3337
|
+
* Call: api.pricing.priceLibrary.list(params)
|
|
3338
|
+
*
|
|
3339
|
+
* List price libraries as Augur holds them locally
|
|
3340
|
+
*
|
|
3341
|
+
* Errors:
|
|
3342
|
+
* 400: OrderBy is not one price_library column with ASC or DESC.
|
|
3343
|
+
*
|
|
3344
|
+
* GET https://pricing.augur-api.com/price-library
|
|
3345
|
+
* Contract: https://pricing.augur-api.com/openapi.json#/paths/~1price-library/get
|
|
3346
|
+
*
|
|
3347
|
+
* @param params PriceLibraryListParams (query string)
|
|
3348
|
+
* @returns BaseResponse whose `data` is PriceLibraryListData
|
|
3349
|
+
*/
|
|
3350
|
+
list: (params?: PriceLibraryListParams) => Promise<BaseResponse<PriceLibraryListData>>;
|
|
3351
|
+
/**
|
|
3352
|
+
* Get Price Library
|
|
3353
|
+
* Call: api.pricing.priceLibrary.get(priceLibraryUid)
|
|
3354
|
+
*
|
|
3355
|
+
* Get one price library as Augur holds it locally
|
|
3356
|
+
*
|
|
3357
|
+
* Errors:
|
|
3358
|
+
* 404: No price library with this priceLibraryUid.
|
|
3359
|
+
*
|
|
3360
|
+
* GET https://pricing.augur-api.com/price-library/{priceLibraryUid}
|
|
3361
|
+
* Contract:
|
|
3362
|
+
* https://pricing.augur-api.com/openapi.json#/paths/~1price-library~1{priceLibraryUid}/get
|
|
3363
|
+
*
|
|
3364
|
+
* @param priceLibraryUid Price library ID (price_library.price_library_uid)
|
|
3365
|
+
* @param params PriceLibraryGetParams (query string)
|
|
3366
|
+
* @returns BaseResponse whose `data` is PriceLibraryGetData
|
|
3367
|
+
*/
|
|
3368
|
+
get: (priceLibraryUid: number, params?: PriceLibraryGetParams) => Promise<BaseResponse<PriceLibraryGetData>>;
|
|
3369
|
+
};
|
|
3370
|
+
priceLibraryXCustXCmpy: {
|
|
3371
|
+
/**
|
|
3372
|
+
* List Price Library To Customer Links
|
|
3373
|
+
* Call: api.pricing.priceLibraryXCustXCmpy.list(params)
|
|
3374
|
+
*
|
|
3375
|
+
* List price library to customer links as Augur holds them locally
|
|
3376
|
+
*
|
|
3377
|
+
* Errors:
|
|
3378
|
+
* 400: CustomerId or priceLibraryUid is not a number, or orderBy is not one
|
|
3379
|
+
* price_library_x_cust_x_cmpy column with ASC or DESC.
|
|
3380
|
+
*
|
|
3381
|
+
* GET https://pricing.augur-api.com/price-library-x-cust-x-cmpy
|
|
3382
|
+
* Contract: https://pricing.augur-api.com/openapi.json#/paths/~1price-library-x-cust-x-cmpy/get
|
|
3383
|
+
*
|
|
3384
|
+
* @param params PriceLibraryXCustXCmpyListParams (query string)
|
|
3385
|
+
* @returns BaseResponse whose `data` is PriceLibraryXCustXCmpyListData
|
|
3386
|
+
*/
|
|
3387
|
+
list: (params?: PriceLibraryXCustXCmpyListParams) => Promise<BaseResponse<PriceLibraryXCustXCmpyListData>>;
|
|
3388
|
+
/**
|
|
3389
|
+
* Get Price Library To Customer Link
|
|
3390
|
+
* Call: api.pricing.priceLibraryXCustXCmpy.get(priceLibXCustXCmpyUid)
|
|
3391
|
+
*
|
|
3392
|
+
* Get one price library to customer link as Augur holds it locally
|
|
3393
|
+
*
|
|
3394
|
+
* Errors:
|
|
3395
|
+
* 404: No price library to customer link with this priceLibXCustXCmpyUid.
|
|
3396
|
+
*
|
|
3397
|
+
* GET https://pricing.augur-api.com/price-library-x-cust-x-cmpy/{priceLibXCustXCmpyUid}
|
|
3398
|
+
* Contract:
|
|
3399
|
+
* https://pricing.augur-api.com/openapi.json#/paths/~1price-library-x-cust-x-cmpy~1{priceLibXCustXCmpyUid}/get
|
|
3400
|
+
*
|
|
3401
|
+
* @param priceLibXCustXCmpyUid Price library to customer link ID
|
|
3402
|
+
* (price_library_x_cust_x_cmpy.price_lib_x_cust_x_cmpy_uid)
|
|
3403
|
+
* @param params PriceLibraryXCustXCmpyGetParams (query string)
|
|
3404
|
+
* @returns BaseResponse whose `data` is PriceLibraryXCustXCmpyGetData
|
|
3405
|
+
*/
|
|
3406
|
+
get: (priceLibXCustXCmpyUid: number, params?: PriceLibraryXCustXCmpyGetParams) => Promise<BaseResponse<PriceLibraryXCustXCmpyGetData>>;
|
|
3407
|
+
};
|
|
3408
|
+
priceLibraryXShipTo: {
|
|
3409
|
+
/**
|
|
3410
|
+
* List Price Library To Ship-to Links
|
|
3411
|
+
* Call: api.pricing.priceLibraryXShipTo.list(params)
|
|
3412
|
+
*
|
|
3413
|
+
* List price library to ship-to links as Augur holds them locally
|
|
3414
|
+
*
|
|
3415
|
+
* Errors:
|
|
3416
|
+
* 400: ShipToId or priceLibraryUid is not a number, or orderBy is not one
|
|
3417
|
+
* price_library_x_ship_to column with ASC or DESC.
|
|
3418
|
+
*
|
|
3419
|
+
* GET https://pricing.augur-api.com/price-library-x-ship-to
|
|
3420
|
+
* Contract: https://pricing.augur-api.com/openapi.json#/paths/~1price-library-x-ship-to/get
|
|
3421
|
+
*
|
|
3422
|
+
* @param params PriceLibraryXShipToListParams (query string)
|
|
3423
|
+
* @returns BaseResponse whose `data` is PriceLibraryXShipToListData
|
|
3424
|
+
*/
|
|
3425
|
+
list: (params?: PriceLibraryXShipToListParams) => Promise<BaseResponse<PriceLibraryXShipToListData>>;
|
|
3426
|
+
/**
|
|
3427
|
+
* Get Price Library To Ship-to Link
|
|
3428
|
+
* Call: api.pricing.priceLibraryXShipTo.get(priceLibraryXShipToUid)
|
|
3429
|
+
*
|
|
3430
|
+
* Get one price library to ship-to link as Augur holds it locally
|
|
3431
|
+
*
|
|
3432
|
+
* Errors:
|
|
3433
|
+
* 404: No price library to ship-to link with this priceLibraryXShipToUid.
|
|
3434
|
+
*
|
|
3435
|
+
* GET https://pricing.augur-api.com/price-library-x-ship-to/{priceLibraryXShipToUid}
|
|
3436
|
+
* Contract:
|
|
3437
|
+
* https://pricing.augur-api.com/openapi.json#/paths/~1price-library-x-ship-to~1{priceLibraryXShipToUid}/get
|
|
3438
|
+
*
|
|
3439
|
+
* @param priceLibraryXShipToUid Price library to ship-to link ID
|
|
3440
|
+
* (price_library_x_ship_to.price_library_x_ship_to_uid)
|
|
3441
|
+
* @param params PriceLibraryXShipToGetParams (query string)
|
|
3442
|
+
* @returns BaseResponse whose `data` is PriceLibraryXShipToGetData
|
|
3443
|
+
*/
|
|
3444
|
+
get: (priceLibraryXShipToUid: number, params?: PriceLibraryXShipToGetParams) => Promise<BaseResponse<PriceLibraryXShipToGetData>>;
|
|
3445
|
+
};
|
|
3446
|
+
priceMethodXCustomer: {
|
|
3447
|
+
/**
|
|
3448
|
+
* List Price Method To Customer Links
|
|
3449
|
+
* Call: api.pricing.priceMethodXCustomer.list(params)
|
|
3450
|
+
*
|
|
3451
|
+
* List price method to customer links as Augur holds them locally
|
|
3452
|
+
*
|
|
3453
|
+
* Errors:
|
|
3454
|
+
* 400: PriceMethodUid or customerId or shipToId is not a number, or orderBy is not one
|
|
3455
|
+
* price_method_x_customer column with ASC or DESC.
|
|
3456
|
+
*
|
|
3457
|
+
* GET https://pricing.augur-api.com/price-method-x-customer
|
|
3458
|
+
* Contract: https://pricing.augur-api.com/openapi.json#/paths/~1price-method-x-customer/get
|
|
3459
|
+
*
|
|
3460
|
+
* @param params PriceMethodXCustomerListParams (query string)
|
|
3461
|
+
* @returns BaseResponse whose `data` is PriceMethodXCustomerListData
|
|
3462
|
+
*/
|
|
3463
|
+
list: (params?: PriceMethodXCustomerListParams) => Promise<BaseResponse<PriceMethodXCustomerListData>>;
|
|
3464
|
+
/**
|
|
3465
|
+
* Get Price Method To Customer Link
|
|
3466
|
+
* Call: api.pricing.priceMethodXCustomer.get(priceMethodXCustomerUid)
|
|
3467
|
+
*
|
|
3468
|
+
* Get one price method to customer link as Augur holds it locally
|
|
3469
|
+
*
|
|
3470
|
+
* Errors:
|
|
3471
|
+
* 404: No price method to customer link with this priceMethodXCustomerUid.
|
|
3472
|
+
*
|
|
3473
|
+
* GET https://pricing.augur-api.com/price-method-x-customer/{priceMethodXCustomerUid}
|
|
3474
|
+
* Contract:
|
|
3475
|
+
* https://pricing.augur-api.com/openapi.json#/paths/~1price-method-x-customer~1{priceMethodXCustomerUid}/get
|
|
3476
|
+
*
|
|
3477
|
+
* @param priceMethodXCustomerUid Price method to customer link ID
|
|
3478
|
+
* (price_method_x_customer.price_method_x_customer_uid)
|
|
3479
|
+
* @param params PriceMethodXCustomerGetParams (query string)
|
|
3480
|
+
* @returns BaseResponse whose `data` is PriceMethodXCustomerGetData
|
|
3481
|
+
*/
|
|
3482
|
+
get: (priceMethodXCustomerUid: number, params?: PriceMethodXCustomerGetParams) => Promise<BaseResponse<PriceMethodXCustomerGetData>>;
|
|
3483
|
+
};
|
|
3484
|
+
pricePage: {
|
|
3485
|
+
/**
|
|
3486
|
+
* List Price Pages
|
|
3487
|
+
* Call: api.pricing.pricePage.list(params)
|
|
3488
|
+
*
|
|
3489
|
+
* List price pages as Augur holds them locally
|
|
3490
|
+
*
|
|
3491
|
+
* Errors:
|
|
3492
|
+
* 400: PriceFamilyUid or invMastUid or supplierId is not a number, or orderBy is not one
|
|
3493
|
+
* price_page column with ASC or DESC.
|
|
3494
|
+
*
|
|
3495
|
+
* GET https://pricing.augur-api.com/price-page
|
|
3496
|
+
* Contract: https://pricing.augur-api.com/openapi.json#/paths/~1price-page/get
|
|
3497
|
+
*
|
|
3498
|
+
* @param params PricePageListParams (query string)
|
|
3499
|
+
* @returns BaseResponse whose `data` is PricePageListData
|
|
3500
|
+
*/
|
|
3501
|
+
list: (params?: PricePageListParams) => Promise<BaseResponse<PricePageListData>>;
|
|
3502
|
+
/**
|
|
3503
|
+
* Get Price Page
|
|
3504
|
+
* Call: api.pricing.pricePage.get(pricePageUid)
|
|
3505
|
+
*
|
|
3506
|
+
* Get one price page as Augur holds it locally
|
|
3507
|
+
*
|
|
3508
|
+
* Errors:
|
|
3509
|
+
* 404: No price page with this pricePageUid.
|
|
3510
|
+
*
|
|
3511
|
+
* GET https://pricing.augur-api.com/price-page/{pricePageUid}
|
|
3512
|
+
* Contract: https://pricing.augur-api.com/openapi.json#/paths/~1price-page~1{pricePageUid}/get
|
|
3513
|
+
*
|
|
3514
|
+
* @param pricePageUid Price page ID (price_page.price_page_uid)
|
|
3515
|
+
* @param params PricePageGetParams (query string)
|
|
3516
|
+
* @returns BaseResponse whose `data` is PricePageGetData
|
|
3517
|
+
*/
|
|
3518
|
+
get: (pricePageUid: number, params?: PricePageGetParams) => Promise<BaseResponse<PricePageGetData>>;
|
|
3519
|
+
};
|
|
3520
|
+
pricePageDealerCommission: {
|
|
3521
|
+
/**
|
|
3522
|
+
* List Price Page Dealer Commission Rows
|
|
3523
|
+
* Call: api.pricing.pricePageDealerCommission.list(params)
|
|
3524
|
+
*
|
|
3525
|
+
* List price page dealer commission rows as Augur holds them locally
|
|
3526
|
+
*
|
|
3527
|
+
* Errors:
|
|
3528
|
+
* 400: PricePageUid is not a number, or orderBy is not one price_page_dealer_commission
|
|
3529
|
+
* column with ASC or DESC.
|
|
3530
|
+
*
|
|
3531
|
+
* GET https://pricing.augur-api.com/price-page-dealer-commission
|
|
3532
|
+
* Contract:
|
|
3533
|
+
* https://pricing.augur-api.com/openapi.json#/paths/~1price-page-dealer-commission/get
|
|
3534
|
+
*
|
|
3535
|
+
* @param params PricePageDealerCommissionListParams (query string)
|
|
3536
|
+
* @returns BaseResponse whose `data` is PricePageDealerCommissionListData
|
|
3537
|
+
*/
|
|
3538
|
+
list: (params?: PricePageDealerCommissionListParams) => Promise<BaseResponse<PricePageDealerCommissionListData>>;
|
|
3539
|
+
/**
|
|
3540
|
+
* Get Price Page Dealer Commission Row
|
|
3541
|
+
* Call: api.pricing.pricePageDealerCommission.get(pricePageDealerCommUid)
|
|
3542
|
+
*
|
|
3543
|
+
* Get one price page dealer commission row as Augur holds it locally
|
|
3544
|
+
*
|
|
3545
|
+
* Errors:
|
|
3546
|
+
* 404: No price page dealer commission row with this pricePageDealerCommUid.
|
|
3547
|
+
*
|
|
3548
|
+
* GET https://pricing.augur-api.com/price-page-dealer-commission/{pricePageDealerCommUid}
|
|
3549
|
+
* Contract:
|
|
3550
|
+
* https://pricing.augur-api.com/openapi.json#/paths/~1price-page-dealer-commission~1{pricePageDealerCommUid}/get
|
|
3551
|
+
*
|
|
3552
|
+
* @param pricePageDealerCommUid Price page dealer commission row ID
|
|
3553
|
+
* (price_page_dealer_commission.price_page_dealer_comm_uid)
|
|
3554
|
+
* @param params PricePageDealerCommissionGetParams (query string)
|
|
3555
|
+
* @returns BaseResponse whose `data` is PricePageDealerCommissionGetData
|
|
3556
|
+
*/
|
|
3557
|
+
get: (pricePageDealerCommUid: number, params?: PricePageDealerCommissionGetParams) => Promise<BaseResponse<PricePageDealerCommissionGetData>>;
|
|
3558
|
+
};
|
|
3559
|
+
pricePageItem: {
|
|
3560
|
+
/**
|
|
3561
|
+
* List Price Page Item Rows
|
|
3562
|
+
* Call: api.pricing.pricePageItem.list(params)
|
|
3563
|
+
*
|
|
3564
|
+
* List price page item rows as Augur holds them locally
|
|
3565
|
+
*
|
|
3566
|
+
* Errors:
|
|
3567
|
+
* 400: PricePageUid is not a number, or orderBy is not one price_page_item column with ASC or
|
|
3568
|
+
* DESC.
|
|
3569
|
+
*
|
|
3570
|
+
* GET https://pricing.augur-api.com/price-page-item
|
|
3571
|
+
* Contract: https://pricing.augur-api.com/openapi.json#/paths/~1price-page-item/get
|
|
3572
|
+
*
|
|
3573
|
+
* @param params PricePageItemListParams (query string)
|
|
3574
|
+
* @returns BaseResponse whose `data` is PricePageItemListData
|
|
3575
|
+
*/
|
|
3576
|
+
list: (params?: PricePageItemListParams) => Promise<BaseResponse<PricePageItemListData>>;
|
|
3577
|
+
/**
|
|
3578
|
+
* Get Price Page Item Row
|
|
3579
|
+
* Call: api.pricing.pricePageItem.get(pricePageItemUid)
|
|
3580
|
+
*
|
|
3581
|
+
* Get one price page item row as Augur holds it locally
|
|
3582
|
+
*
|
|
3583
|
+
* Errors:
|
|
3584
|
+
* 404: No price page item row with this pricePageItemUid.
|
|
3585
|
+
*
|
|
3586
|
+
* GET https://pricing.augur-api.com/price-page-item/{pricePageItemUid}
|
|
3587
|
+
* Contract:
|
|
3588
|
+
* https://pricing.augur-api.com/openapi.json#/paths/~1price-page-item~1{pricePageItemUid}/get
|
|
3589
|
+
*
|
|
3590
|
+
* @param pricePageItemUid Price page item row ID (price_page_item.price_page_item_uid)
|
|
3591
|
+
* @param params PricePageItemGetParams (query string)
|
|
3592
|
+
* @returns BaseResponse whose `data` is PricePageItemGetData
|
|
3593
|
+
*/
|
|
3594
|
+
get: (pricePageItemUid: number, params?: PricePageItemGetParams) => Promise<BaseResponse<PricePageItemGetData>>;
|
|
3595
|
+
};
|
|
3596
|
+
pricePagePoCostCalc: {
|
|
3597
|
+
/**
|
|
3598
|
+
* List Price Page PO Cost Calculation Rows
|
|
3599
|
+
* Call: api.pricing.pricePagePoCostCalc.list(params)
|
|
3600
|
+
*
|
|
3601
|
+
* List price page PO cost calculation rows as Augur holds them locally
|
|
3602
|
+
*
|
|
3603
|
+
* Errors:
|
|
3604
|
+
* 400: PricePageUid is not a number, or orderBy is not one price_page_po_cost_calc column
|
|
3605
|
+
* with ASC or DESC.
|
|
3606
|
+
*
|
|
3607
|
+
* GET https://pricing.augur-api.com/price-page-po-cost-calc
|
|
3608
|
+
* Contract: https://pricing.augur-api.com/openapi.json#/paths/~1price-page-po-cost-calc/get
|
|
3609
|
+
*
|
|
3610
|
+
* @param params PricePagePoCostCalcListParams (query string)
|
|
3611
|
+
* @returns BaseResponse whose `data` is PricePagePoCostCalcListData
|
|
3612
|
+
*/
|
|
3613
|
+
list: (params?: PricePagePoCostCalcListParams) => Promise<BaseResponse<PricePagePoCostCalcListData>>;
|
|
3614
|
+
/**
|
|
3615
|
+
* Get Price Page PO Cost Calculation Row
|
|
3616
|
+
* Call: api.pricing.pricePagePoCostCalc.get(pricePagePoCostCalcUid)
|
|
3617
|
+
*
|
|
3618
|
+
* Get one price page PO cost calculation row as Augur holds it locally
|
|
3619
|
+
*
|
|
3620
|
+
* Errors:
|
|
3621
|
+
* 404: No price page PO cost calculation row with this pricePagePoCostCalcUid.
|
|
3622
|
+
*
|
|
3623
|
+
* GET https://pricing.augur-api.com/price-page-po-cost-calc/{pricePagePoCostCalcUid}
|
|
3624
|
+
* Contract:
|
|
3625
|
+
* https://pricing.augur-api.com/openapi.json#/paths/~1price-page-po-cost-calc~1{pricePagePoCostCalcUid}/get
|
|
3626
|
+
*
|
|
3627
|
+
* @param pricePagePoCostCalcUid Price page PO cost calculation row ID
|
|
3628
|
+
* (price_page_po_cost_calc.price_page_po_cost_calc_uid)
|
|
3629
|
+
* @param params PricePagePoCostCalcGetParams (query string)
|
|
3630
|
+
* @returns BaseResponse whose `data` is PricePagePoCostCalcGetData
|
|
3631
|
+
*/
|
|
3632
|
+
get: (pricePagePoCostCalcUid: number, params?: PricePagePoCostCalcGetParams) => Promise<BaseResponse<PricePagePoCostCalcGetData>>;
|
|
3633
|
+
};
|
|
3634
|
+
pricePagePricefam: {
|
|
3635
|
+
/**
|
|
3636
|
+
* List Price Page Price Family Rows
|
|
3637
|
+
* Call: api.pricing.pricePagePricefam.list(params)
|
|
3638
|
+
*
|
|
3639
|
+
* List price page price family rows as Augur holds them locally
|
|
3640
|
+
*
|
|
3641
|
+
* Errors:
|
|
3642
|
+
* 400: PricePageUid is not a number, or orderBy is not one price_page_pricefam column with
|
|
3643
|
+
* ASC or DESC.
|
|
3644
|
+
*
|
|
3645
|
+
* GET https://pricing.augur-api.com/price-page-pricefam
|
|
3646
|
+
* Contract: https://pricing.augur-api.com/openapi.json#/paths/~1price-page-pricefam/get
|
|
3647
|
+
*
|
|
3648
|
+
* @param params PricePagePricefamListParams (query string)
|
|
3649
|
+
* @returns BaseResponse whose `data` is PricePagePricefamListData
|
|
3650
|
+
*/
|
|
3651
|
+
list: (params?: PricePagePricefamListParams) => Promise<BaseResponse<PricePagePricefamListData>>;
|
|
3652
|
+
/**
|
|
3653
|
+
* Get Price Page Price Family Row
|
|
3654
|
+
* Call: api.pricing.pricePagePricefam.get(pricePagePricefamUid)
|
|
3655
|
+
*
|
|
3656
|
+
* Get one price page price family row as Augur holds it locally
|
|
3657
|
+
*
|
|
3658
|
+
* Errors:
|
|
3659
|
+
* 404: No price page price family row with this pricePagePricefamUid.
|
|
3660
|
+
*
|
|
3661
|
+
* GET https://pricing.augur-api.com/price-page-pricefam/{pricePagePricefamUid}
|
|
3662
|
+
* Contract:
|
|
3663
|
+
* https://pricing.augur-api.com/openapi.json#/paths/~1price-page-pricefam~1{pricePagePricefamUid}/get
|
|
3664
|
+
*
|
|
3665
|
+
* @param pricePagePricefamUid Price page price family row ID
|
|
3666
|
+
* (price_page_pricefam.price_page_pricefam_uid)
|
|
3667
|
+
* @param params PricePagePricefamGetParams (query string)
|
|
3668
|
+
* @returns BaseResponse whose `data` is PricePagePricefamGetData
|
|
3669
|
+
*/
|
|
3670
|
+
get: (pricePagePricefamUid: number, params?: PricePagePricefamGetParams) => Promise<BaseResponse<PricePagePricefamGetData>>;
|
|
3671
|
+
};
|
|
3672
|
+
pricePageProdgrp: {
|
|
3673
|
+
/**
|
|
3674
|
+
* List Price Page Product Group Rows
|
|
3675
|
+
* Call: api.pricing.pricePageProdgrp.list(params)
|
|
3676
|
+
*
|
|
3677
|
+
* List price page product group rows as Augur holds them locally
|
|
3678
|
+
*
|
|
3679
|
+
* Errors:
|
|
3680
|
+
* 400: PricePageUid is not a number, or orderBy is not one price_page_prodgrp column with ASC
|
|
3681
|
+
* or DESC.
|
|
3682
|
+
*
|
|
3683
|
+
* GET https://pricing.augur-api.com/price-page-prodgrp
|
|
3684
|
+
* Contract: https://pricing.augur-api.com/openapi.json#/paths/~1price-page-prodgrp/get
|
|
3685
|
+
*
|
|
3686
|
+
* @param params PricePageProdgrpListParams (query string)
|
|
3687
|
+
* @returns BaseResponse whose `data` is PricePageProdgrpListData
|
|
3688
|
+
*/
|
|
3689
|
+
list: (params?: PricePageProdgrpListParams) => Promise<BaseResponse<PricePageProdgrpListData>>;
|
|
3690
|
+
/**
|
|
3691
|
+
* Get Price Page Product Group Row
|
|
3692
|
+
* Call: api.pricing.pricePageProdgrp.get(pricePageProdgrpUid)
|
|
3693
|
+
*
|
|
3694
|
+
* Get one price page product group row as Augur holds it locally
|
|
3695
|
+
*
|
|
3696
|
+
* Errors:
|
|
3697
|
+
* 404: No price page product group row with this pricePageProdgrpUid.
|
|
3698
|
+
*
|
|
3699
|
+
* GET https://pricing.augur-api.com/price-page-prodgrp/{pricePageProdgrpUid}
|
|
3700
|
+
* Contract:
|
|
3701
|
+
* https://pricing.augur-api.com/openapi.json#/paths/~1price-page-prodgrp~1{pricePageProdgrpUid}/get
|
|
3702
|
+
*
|
|
3703
|
+
* @param pricePageProdgrpUid Price page product group row ID
|
|
3704
|
+
* (price_page_prodgrp.price_page_prodgrp_uid)
|
|
3705
|
+
* @param params PricePageProdgrpGetParams (query string)
|
|
3706
|
+
* @returns BaseResponse whose `data` is PricePageProdgrpGetData
|
|
3707
|
+
*/
|
|
3708
|
+
get: (pricePageProdgrpUid: number, params?: PricePageProdgrpGetParams) => Promise<BaseResponse<PricePageProdgrpGetData>>;
|
|
3709
|
+
};
|
|
3710
|
+
pricePageSecondaryRebate: {
|
|
3711
|
+
/**
|
|
3712
|
+
* List Price Page Secondary Rebate Rows
|
|
3713
|
+
* Call: api.pricing.pricePageSecondaryRebate.list(params)
|
|
3714
|
+
*
|
|
3715
|
+
* List price page secondary rebate rows as Augur holds them locally
|
|
3716
|
+
*
|
|
3717
|
+
* Errors:
|
|
3718
|
+
* 400: PricePageUid is not a number, or orderBy is not one price_page_secondary_rebate column
|
|
3719
|
+
* with ASC or DESC.
|
|
3720
|
+
*
|
|
3721
|
+
* GET https://pricing.augur-api.com/price-page-secondary-rebate
|
|
3722
|
+
* Contract: https://pricing.augur-api.com/openapi.json#/paths/~1price-page-secondary-rebate/get
|
|
3723
|
+
*
|
|
3724
|
+
* @param params PricePageSecondaryRebateListParams (query string)
|
|
3725
|
+
* @returns BaseResponse whose `data` is PricePageSecondaryRebateListData
|
|
3726
|
+
*/
|
|
3727
|
+
list: (params?: PricePageSecondaryRebateListParams) => Promise<BaseResponse<PricePageSecondaryRebateListData>>;
|
|
3728
|
+
/**
|
|
3729
|
+
* Get Price Page Secondary Rebate Row
|
|
3730
|
+
* Call: api.pricing.pricePageSecondaryRebate.get(pricePageSecondaryRebateUid)
|
|
3731
|
+
*
|
|
3732
|
+
* Get one price page secondary rebate row as Augur holds it locally
|
|
3733
|
+
*
|
|
3734
|
+
* Errors:
|
|
3735
|
+
* 404: No price page secondary rebate row with this pricePageSecondaryRebateUid.
|
|
3736
|
+
*
|
|
3737
|
+
* GET https://pricing.augur-api.com/price-page-secondary-rebate/{pricePageSecondaryRebateUid}
|
|
3738
|
+
* Contract:
|
|
3739
|
+
* https://pricing.augur-api.com/openapi.json#/paths/~1price-page-secondary-rebate~1{pricePageSecondaryRebateUid}/get
|
|
3740
|
+
*
|
|
3741
|
+
* @param pricePageSecondaryRebateUid Price page secondary rebate row ID
|
|
3742
|
+
* (price_page_secondary_rebate.price_page_secondary_rebate_uid)
|
|
3743
|
+
* @param params PricePageSecondaryRebateGetParams (query string)
|
|
3744
|
+
* @returns BaseResponse whose `data` is PricePageSecondaryRebateGetData
|
|
3745
|
+
*/
|
|
3746
|
+
get: (pricePageSecondaryRebateUid: number, params?: PricePageSecondaryRebateGetParams) => Promise<BaseResponse<PricePageSecondaryRebateGetData>>;
|
|
3747
|
+
};
|
|
3748
|
+
pricePageSuppdisc: {
|
|
3749
|
+
/**
|
|
3750
|
+
* List Price Page Supplier Discount Rows
|
|
3751
|
+
* Call: api.pricing.pricePageSuppdisc.list(params)
|
|
3752
|
+
*
|
|
3753
|
+
* List price page supplier discount rows as Augur holds them locally
|
|
3754
|
+
*
|
|
3755
|
+
* Errors:
|
|
3756
|
+
* 400: PricePageUid is not a number, or orderBy is not one price_page_suppdisc column with
|
|
3757
|
+
* ASC or DESC.
|
|
3758
|
+
*
|
|
3759
|
+
* GET https://pricing.augur-api.com/price-page-suppdisc
|
|
3760
|
+
* Contract: https://pricing.augur-api.com/openapi.json#/paths/~1price-page-suppdisc/get
|
|
3761
|
+
*
|
|
3762
|
+
* @param params PricePageSuppdiscListParams (query string)
|
|
3763
|
+
* @returns BaseResponse whose `data` is PricePageSuppdiscListData
|
|
3764
|
+
*/
|
|
3765
|
+
list: (params?: PricePageSuppdiscListParams) => Promise<BaseResponse<PricePageSuppdiscListData>>;
|
|
3766
|
+
/**
|
|
3767
|
+
* Get Price Page Supplier Discount Row
|
|
3768
|
+
* Call: api.pricing.pricePageSuppdisc.get(pricePageSuppdiscUid)
|
|
3769
|
+
*
|
|
3770
|
+
* Get one price page supplier discount row as Augur holds it locally
|
|
3771
|
+
*
|
|
3772
|
+
* Errors:
|
|
3773
|
+
* 404: No price page supplier discount row with this pricePageSuppdiscUid.
|
|
3774
|
+
*
|
|
3775
|
+
* GET https://pricing.augur-api.com/price-page-suppdisc/{pricePageSuppdiscUid}
|
|
3776
|
+
* Contract:
|
|
3777
|
+
* https://pricing.augur-api.com/openapi.json#/paths/~1price-page-suppdisc~1{pricePageSuppdiscUid}/get
|
|
3778
|
+
*
|
|
3779
|
+
* @param pricePageSuppdiscUid Price page supplier discount row ID
|
|
3780
|
+
* (price_page_suppdisc.price_page_suppdisc_uid)
|
|
3781
|
+
* @param params PricePageSuppdiscGetParams (query string)
|
|
3782
|
+
* @returns BaseResponse whose `data` is PricePageSuppdiscGetData
|
|
3783
|
+
*/
|
|
3784
|
+
get: (pricePageSuppdiscUid: number, params?: PricePageSuppdiscGetParams) => Promise<BaseResponse<PricePageSuppdiscGetData>>;
|
|
3785
|
+
};
|
|
3786
|
+
pricePageSupplier: {
|
|
3787
|
+
/**
|
|
3788
|
+
* List Price Page Supplier Rows
|
|
3789
|
+
* Call: api.pricing.pricePageSupplier.list(params)
|
|
3790
|
+
*
|
|
3791
|
+
* List price page supplier rows as Augur holds them locally
|
|
3792
|
+
*
|
|
3793
|
+
* Errors:
|
|
3794
|
+
* 400: PricePageUid is not a number, or orderBy is not one price_page_supplier column with
|
|
3795
|
+
* ASC or DESC.
|
|
3796
|
+
*
|
|
3797
|
+
* GET https://pricing.augur-api.com/price-page-supplier
|
|
3798
|
+
* Contract: https://pricing.augur-api.com/openapi.json#/paths/~1price-page-supplier/get
|
|
3799
|
+
*
|
|
3800
|
+
* @param params PricePageSupplierListParams (query string)
|
|
3801
|
+
* @returns BaseResponse whose `data` is PricePageSupplierListData
|
|
3802
|
+
*/
|
|
3803
|
+
list: (params?: PricePageSupplierListParams) => Promise<BaseResponse<PricePageSupplierListData>>;
|
|
3804
|
+
/**
|
|
3805
|
+
* Get Price Page Supplier Row
|
|
3806
|
+
* Call: api.pricing.pricePageSupplier.get(pricePageSupplierUid)
|
|
3807
|
+
*
|
|
3808
|
+
* Get one price page supplier row as Augur holds it locally
|
|
3809
|
+
*
|
|
3810
|
+
* Errors:
|
|
3811
|
+
* 404: No price page supplier row with this pricePageSupplierUid.
|
|
3812
|
+
*
|
|
3813
|
+
* GET https://pricing.augur-api.com/price-page-supplier/{pricePageSupplierUid}
|
|
3814
|
+
* Contract:
|
|
3815
|
+
* https://pricing.augur-api.com/openapi.json#/paths/~1price-page-supplier~1{pricePageSupplierUid}/get
|
|
3816
|
+
*
|
|
3817
|
+
* @param pricePageSupplierUid Price page supplier row ID
|
|
3818
|
+
* (price_page_supplier.price_page_supplier_uid)
|
|
3819
|
+
* @param params PricePageSupplierGetParams (query string)
|
|
3820
|
+
* @returns BaseResponse whose `data` is PricePageSupplierGetData
|
|
3821
|
+
*/
|
|
3822
|
+
get: (pricePageSupplierUid: number, params?: PricePageSupplierGetParams) => Promise<BaseResponse<PricePageSupplierGetData>>;
|
|
3823
|
+
};
|
|
3824
|
+
pricePageTypeXCompany: {
|
|
3825
|
+
/**
|
|
3826
|
+
* List Price Page Type To Company Links
|
|
3827
|
+
* Call: api.pricing.pricePageTypeXCompany.list(params)
|
|
3828
|
+
*
|
|
3829
|
+
* List price page type to company links as Augur holds them locally
|
|
3830
|
+
*
|
|
3831
|
+
* Errors:
|
|
3832
|
+
* 400: OrderBy is not one price_page_type_x_company column with ASC or DESC.
|
|
3833
|
+
*
|
|
3834
|
+
* GET https://pricing.augur-api.com/price-page-type-x-company
|
|
3835
|
+
* Contract: https://pricing.augur-api.com/openapi.json#/paths/~1price-page-type-x-company/get
|
|
3836
|
+
*
|
|
3837
|
+
* @param params PricePageTypeXCompanyListParams (query string)
|
|
3838
|
+
* @returns BaseResponse whose `data` is PricePageTypeXCompanyListData
|
|
3839
|
+
*/
|
|
3840
|
+
list: (params?: PricePageTypeXCompanyListParams) => Promise<BaseResponse<PricePageTypeXCompanyListData>>;
|
|
3841
|
+
/**
|
|
3842
|
+
* Get Price Page Type To Company Link
|
|
3843
|
+
* Call: api.pricing.pricePageTypeXCompany.get(pricePageTypeXCompanyUid)
|
|
3844
|
+
*
|
|
3845
|
+
* Get one price page type to company link as Augur holds it locally
|
|
3846
|
+
*
|
|
3847
|
+
* Errors:
|
|
3848
|
+
* 404: No price page type to company link with this pricePageTypeXCompanyUid.
|
|
3849
|
+
*
|
|
3850
|
+
* GET https://pricing.augur-api.com/price-page-type-x-company/{pricePageTypeXCompanyUid}
|
|
3851
|
+
* Contract:
|
|
3852
|
+
* https://pricing.augur-api.com/openapi.json#/paths/~1price-page-type-x-company~1{pricePageTypeXCompanyUid}/get
|
|
3853
|
+
*
|
|
3854
|
+
* @param pricePageTypeXCompanyUid Price page type to company link ID
|
|
3855
|
+
* (price_page_type_x_company.price_page_type_x_company_uid)
|
|
3856
|
+
* @param params PricePageTypeXCompanyGetParams (query string)
|
|
3857
|
+
* @returns BaseResponse whose `data` is PricePageTypeXCompanyGetData
|
|
3858
|
+
*/
|
|
3859
|
+
get: (pricePageTypeXCompanyUid: number, params?: PricePageTypeXCompanyGetParams) => Promise<BaseResponse<PricePageTypeXCompanyGetData>>;
|
|
3860
|
+
};
|
|
3861
|
+
pricePageXBook: {
|
|
3862
|
+
/**
|
|
3863
|
+
* List Price Page To Book Links
|
|
3864
|
+
* Call: api.pricing.pricePageXBook.list(params)
|
|
3865
|
+
*
|
|
3866
|
+
* List price page to book links as Augur holds them locally
|
|
3867
|
+
*
|
|
3868
|
+
* Errors:
|
|
3869
|
+
* 400: PriceBookUid or pricePageUid is not a number, or orderBy is not one price_page_x_book
|
|
3870
|
+
* column with ASC or DESC.
|
|
3871
|
+
*
|
|
3872
|
+
* GET https://pricing.augur-api.com/price-page-x-book
|
|
3873
|
+
* Contract: https://pricing.augur-api.com/openapi.json#/paths/~1price-page-x-book/get
|
|
3874
|
+
*
|
|
3875
|
+
* @param params PricePageXBookListParams (query string)
|
|
3876
|
+
* @returns BaseResponse whose `data` is PricePageXBookListData
|
|
3877
|
+
*/
|
|
3878
|
+
list: (params?: PricePageXBookListParams) => Promise<BaseResponse<PricePageXBookListData>>;
|
|
3879
|
+
/**
|
|
3880
|
+
* Get Price Page To Book Link
|
|
3881
|
+
* Call: api.pricing.pricePageXBook.get(pricePageXBookUid)
|
|
3882
|
+
*
|
|
3883
|
+
* Get one price page to book link as Augur holds it locally
|
|
3884
|
+
*
|
|
3885
|
+
* Errors:
|
|
3886
|
+
* 404: No price page to book link with this pricePageXBookUid.
|
|
3887
|
+
*
|
|
3888
|
+
* GET https://pricing.augur-api.com/price-page-x-book/{pricePageXBookUid}
|
|
3889
|
+
* Contract:
|
|
3890
|
+
* https://pricing.augur-api.com/openapi.json#/paths/~1price-page-x-book~1{pricePageXBookUid}/get
|
|
3891
|
+
*
|
|
3892
|
+
* @param pricePageXBookUid Price page to book link ID (price_page_x_book.price_page_x_book_uid)
|
|
3893
|
+
* @param params PricePageXBookGetParams (query string)
|
|
3894
|
+
* @returns BaseResponse whose `data` is PricePageXBookGetData
|
|
3895
|
+
*/
|
|
3896
|
+
get: (pricePageXBookUid: number, params?: PricePageXBookGetParams) => Promise<BaseResponse<PricePageXBookGetData>>;
|
|
3897
|
+
};
|
|
3898
|
+
priceSourceXCompany: {
|
|
3899
|
+
/**
|
|
3900
|
+
* List Price Source To Company Links
|
|
3901
|
+
* Call: api.pricing.priceSourceXCompany.list(params)
|
|
3902
|
+
*
|
|
3903
|
+
* List price source to company links as Augur holds them locally
|
|
3904
|
+
*
|
|
3905
|
+
* Errors:
|
|
3906
|
+
* 400: OrderBy is not one price_source_x_company column with ASC or DESC.
|
|
3907
|
+
*
|
|
3908
|
+
* GET https://pricing.augur-api.com/price-source-x-company
|
|
3909
|
+
* Contract: https://pricing.augur-api.com/openapi.json#/paths/~1price-source-x-company/get
|
|
3910
|
+
*
|
|
3911
|
+
* @param params PriceSourceXCompanyListParams (query string)
|
|
3912
|
+
* @returns BaseResponse whose `data` is PriceSourceXCompanyListData
|
|
3913
|
+
*/
|
|
3914
|
+
list: (params?: PriceSourceXCompanyListParams) => Promise<BaseResponse<PriceSourceXCompanyListData>>;
|
|
3915
|
+
/**
|
|
3916
|
+
* Get Price Source To Company Link
|
|
3917
|
+
* Call: api.pricing.priceSourceXCompany.get(priceSourceXCompanyUid)
|
|
3918
|
+
*
|
|
3919
|
+
* Get one price source to company link as Augur holds it locally
|
|
3920
|
+
*
|
|
3921
|
+
* Errors:
|
|
3922
|
+
* 404: No price source to company link with this priceSourceXCompanyUid.
|
|
3923
|
+
*
|
|
3924
|
+
* GET https://pricing.augur-api.com/price-source-x-company/{priceSourceXCompanyUid}
|
|
3925
|
+
* Contract:
|
|
3926
|
+
* https://pricing.augur-api.com/openapi.json#/paths/~1price-source-x-company~1{priceSourceXCompanyUid}/get
|
|
3927
|
+
*
|
|
3928
|
+
* @param priceSourceXCompanyUid Price source to company link ID
|
|
3929
|
+
* (price_source_x_company.price_source_x_company_uid)
|
|
3930
|
+
* @param params PriceSourceXCompanyGetParams (query string)
|
|
3931
|
+
* @returns BaseResponse whose `data` is PriceSourceXCompanyGetData
|
|
3932
|
+
*/
|
|
3933
|
+
get: (priceSourceXCompanyUid: number, params?: PriceSourceXCompanyGetParams) => Promise<BaseResponse<PriceSourceXCompanyGetData>>;
|
|
3934
|
+
};
|
|
3935
|
+
taxEngine: {
|
|
3936
|
+
/**
|
|
3937
|
+
* Estimate Sales Tax
|
|
3938
|
+
* Call: api.pricing.taxEngine.create(data)
|
|
3939
|
+
*
|
|
3940
|
+
* Estimate sales tax for a list of items shipped to one postal code; items without a unitPrice
|
|
3941
|
+
* are priced through the price engine for the customer
|
|
3942
|
+
*
|
|
3943
|
+
* Request body: Items to estimate sales tax for, shipped to one postal code
|
|
3944
|
+
* Response data: Sales tax estimate for a set of items shipped to one postal code
|
|
3945
|
+
*
|
|
3946
|
+
* Errors:
|
|
3947
|
+
* 400: The body is missing or not a JSON object. Or Request body is required with postalCode
|
|
3948
|
+
* and items array. Or A required body field is missing or has the wrong type.
|
|
3949
|
+
*
|
|
3950
|
+
* POST https://pricing.augur-api.com/tax-engine
|
|
3951
|
+
* Contract: https://pricing.augur-api.com/openapi.json#/paths/~1tax-engine/post
|
|
3952
|
+
*
|
|
3953
|
+
* @param data TaxEngineCreateBody (request body)
|
|
3954
|
+
* @returns BaseResponse whose `data` is TaxEngineCreateData
|
|
3955
|
+
*/
|
|
3956
|
+
create: (data: TaxEngineCreateBody) => Promise<BaseResponse<TaxEngineCreateData>>;
|
|
3957
|
+
};
|
|
3958
|
+
taxGroupHdr: {
|
|
3959
|
+
/**
|
|
3960
|
+
* List Tax Groups
|
|
3961
|
+
* Call: api.pricing.taxGroupHdr.list(params)
|
|
3962
|
+
*
|
|
3963
|
+
* List tax groups as Augur holds them locally
|
|
3964
|
+
*
|
|
3965
|
+
* Errors:
|
|
3966
|
+
* 400: DeleteFlag is not Y or N, or orderBy is not one tax_group_hdr column with ASC or DESC.
|
|
3967
|
+
*
|
|
3968
|
+
* GET https://pricing.augur-api.com/tax-group-hdr
|
|
3969
|
+
* Contract: https://pricing.augur-api.com/openapi.json#/paths/~1tax-group-hdr/get
|
|
3970
|
+
*
|
|
3971
|
+
* @param params TaxGroupHdrListParams (query string)
|
|
3972
|
+
* @returns BaseResponse whose `data` is TaxGroupHdrListData
|
|
3973
|
+
*/
|
|
3974
|
+
list: (params?: TaxGroupHdrListParams) => Promise<BaseResponse<TaxGroupHdrListData>>;
|
|
3975
|
+
};
|
|
3976
|
+
taxGroupHdrZip: {
|
|
3977
|
+
/**
|
|
3978
|
+
* List Tax Group Postal Code Rows
|
|
3979
|
+
* Call: api.pricing.taxGroupHdrZip.list(params)
|
|
3980
|
+
*
|
|
3981
|
+
* List tax group postal code rows as Augur holds them locally
|
|
3982
|
+
*
|
|
3983
|
+
* Errors:
|
|
3984
|
+
* 400: OrderBy is not one tax_group_hdr_zip column with ASC or DESC.
|
|
3985
|
+
*
|
|
3986
|
+
* GET https://pricing.augur-api.com/tax-group-hdr-zip
|
|
3987
|
+
* Contract: https://pricing.augur-api.com/openapi.json#/paths/~1tax-group-hdr-zip/get
|
|
3988
|
+
*
|
|
3989
|
+
* @param params TaxGroupHdrZipListParams (query string)
|
|
3990
|
+
* @returns BaseResponse whose `data` is TaxGroupHdrZipListData
|
|
3991
|
+
*/
|
|
3992
|
+
list: (params?: TaxGroupHdrZipListParams) => Promise<BaseResponse<TaxGroupHdrZipListData>>;
|
|
3993
|
+
/**
|
|
3994
|
+
* Get Tax Group Postal Code Row
|
|
3995
|
+
* Call: api.pricing.taxGroupHdrZip.get(taxGroupHdrZipUid)
|
|
3996
|
+
*
|
|
3997
|
+
* Get one tax group postal code row as Augur holds it locally
|
|
3998
|
+
*
|
|
3999
|
+
* Errors:
|
|
4000
|
+
* 404: No tax group postal code row with this taxGroupHdrZipUid.
|
|
4001
|
+
*
|
|
4002
|
+
* GET https://pricing.augur-api.com/tax-group-hdr-zip/{taxGroupHdrZipUid}
|
|
4003
|
+
* Contract:
|
|
4004
|
+
* https://pricing.augur-api.com/openapi.json#/paths/~1tax-group-hdr-zip~1{taxGroupHdrZipUid}/get
|
|
4005
|
+
*
|
|
4006
|
+
* @param taxGroupHdrZipUid Tax group postal code row ID
|
|
4007
|
+
* (tax_group_hdr_zip.tax_group_hdr_zip_uid)
|
|
4008
|
+
* @param params TaxGroupHdrZipGetParams (query string)
|
|
4009
|
+
* @returns BaseResponse whose `data` is TaxGroupHdrZipGetData
|
|
4010
|
+
*/
|
|
4011
|
+
get: (taxGroupHdrZipUid: number, params?: TaxGroupHdrZipGetParams) => Promise<BaseResponse<TaxGroupHdrZipGetData>>;
|
|
4012
|
+
};
|
|
4013
|
+
taxGroupLine: {
|
|
4014
|
+
/**
|
|
4015
|
+
* List Tax Group Lines
|
|
4016
|
+
* Call: api.pricing.taxGroupLine.list(params)
|
|
4017
|
+
*
|
|
4018
|
+
* List tax group lines as Augur holds them locally
|
|
4019
|
+
*
|
|
4020
|
+
* Errors:
|
|
4021
|
+
* 400: DeleteFlag is not Y or N, or orderBy is not one tax_group_line column with ASC or
|
|
4022
|
+
* DESC.
|
|
4023
|
+
*
|
|
4024
|
+
* GET https://pricing.augur-api.com/tax-group-line
|
|
4025
|
+
* Contract: https://pricing.augur-api.com/openapi.json#/paths/~1tax-group-line/get
|
|
4026
|
+
*
|
|
4027
|
+
* @param params TaxGroupLineListParams (query string)
|
|
4028
|
+
* @returns BaseResponse whose `data` is TaxGroupLineListData
|
|
4029
|
+
*/
|
|
4030
|
+
list: (params?: TaxGroupLineListParams) => Promise<BaseResponse<TaxGroupLineListData>>;
|
|
4031
|
+
};
|
|
4032
|
+
taxJurisdiction: {
|
|
4033
|
+
/**
|
|
4034
|
+
* List Tax Jurisdictions
|
|
4035
|
+
* Call: api.pricing.taxJurisdiction.list(params)
|
|
4036
|
+
*
|
|
4037
|
+
* List tax jurisdictions as Augur holds them locally
|
|
4038
|
+
*
|
|
4039
|
+
* Errors:
|
|
4040
|
+
* 400: DeleteFlag is not Y or N, or orderBy is not one tax_jurisdiction column with ASC or
|
|
4041
|
+
* DESC.
|
|
4042
|
+
*
|
|
4043
|
+
* GET https://pricing.augur-api.com/tax-jurisdiction
|
|
4044
|
+
* Contract: https://pricing.augur-api.com/openapi.json#/paths/~1tax-jurisdiction/get
|
|
4045
|
+
*
|
|
4046
|
+
* @param params TaxJurisdictionListParams (query string)
|
|
4047
|
+
* @returns BaseResponse whose `data` is TaxJurisdictionListData
|
|
4048
|
+
*/
|
|
4049
|
+
list: (params?: TaxJurisdictionListParams) => Promise<BaseResponse<TaxJurisdictionListData>>;
|
|
4050
|
+
/**
|
|
4051
|
+
* Get Tax Jurisdiction
|
|
4052
|
+
* Call: api.pricing.taxJurisdiction.get(jurisdictionId)
|
|
4053
|
+
*
|
|
4054
|
+
* Get one tax jurisdiction as Augur holds it locally
|
|
4055
|
+
*
|
|
4056
|
+
* Errors:
|
|
4057
|
+
* 400: jurisdictionId is missing or invalid.
|
|
4058
|
+
* 404: No tax jurisdiction with this jurisdictionId.
|
|
4059
|
+
*
|
|
4060
|
+
* GET https://pricing.augur-api.com/tax-jurisdiction/{jurisdictionId}
|
|
4061
|
+
* Contract:
|
|
4062
|
+
* https://pricing.augur-api.com/openapi.json#/paths/~1tax-jurisdiction~1{jurisdictionId}/get
|
|
4063
|
+
*
|
|
4064
|
+
* @param jurisdictionId Tax jurisdiction ID (tax_jurisdiction.jurisdiction_id)
|
|
4065
|
+
* @param params TaxJurisdictionGetParams (query string)
|
|
4066
|
+
* @returns BaseResponse whose `data` is TaxJurisdictionGetData
|
|
4067
|
+
*/
|
|
4068
|
+
get: (jurisdictionId: string, params?: TaxJurisdictionGetParams) => Promise<BaseResponse<TaxJurisdictionGetData>>;
|
|
4069
|
+
};
|
|
4070
|
+
webPricing: {
|
|
4071
|
+
/**
|
|
4072
|
+
* List Web Pricing Rules
|
|
4073
|
+
* Call: api.pricing.webPricing.list(params)
|
|
4074
|
+
*
|
|
4075
|
+
* Errors:
|
|
4076
|
+
* 400: Invalid orderBy: MUST be one field|ASC or field|DESC, the field a web_pricing column.
|
|
4077
|
+
*
|
|
4078
|
+
* GET https://pricing.augur-api.com/web-pricing
|
|
4079
|
+
* Contract: https://pricing.augur-api.com/openapi.json#/paths/~1web-pricing/get
|
|
4080
|
+
*
|
|
4081
|
+
* @param params WebPricingListParams (query string)
|
|
4082
|
+
* @returns BaseResponse whose `data` is WebPricingListData
|
|
4083
|
+
*/
|
|
4084
|
+
list: (params?: WebPricingListParams) => Promise<BaseResponse<WebPricingListData>>;
|
|
4085
|
+
/**
|
|
4086
|
+
* Create Web Pricing Rule
|
|
4087
|
+
* Call: api.pricing.webPricing.create(data)
|
|
4088
|
+
*
|
|
4089
|
+
* Request body: Create a web pricing rule: a percentage discount off the price engine unit
|
|
4090
|
+
* price
|
|
4091
|
+
*
|
|
4092
|
+
* Success status: 201 (not 200)
|
|
4093
|
+
*
|
|
4094
|
+
* Errors:
|
|
4095
|
+
* 400: The body is missing or not a JSON object. Or The body failed validation; the message
|
|
4096
|
+
* names the field.
|
|
4097
|
+
*
|
|
4098
|
+
* POST https://pricing.augur-api.com/web-pricing
|
|
4099
|
+
* Contract: https://pricing.augur-api.com/openapi.json#/paths/~1web-pricing/post
|
|
4100
|
+
*
|
|
4101
|
+
* @param data WebPricingCreateBody (request body)
|
|
4102
|
+
* @returns BaseResponse whose `data` is WebPricingCreateData
|
|
4103
|
+
*/
|
|
4104
|
+
create: (data: WebPricingCreateBody) => Promise<BaseResponse<WebPricingCreateData>>;
|
|
4105
|
+
/**
|
|
4106
|
+
* Get Web Pricing Rule
|
|
4107
|
+
* Call: api.pricing.webPricing.get(webPricingUid)
|
|
4108
|
+
*
|
|
4109
|
+
* Errors:
|
|
4110
|
+
* 404: No record with this ID.
|
|
4111
|
+
*
|
|
4112
|
+
* GET https://pricing.augur-api.com/web-pricing/{webPricingUid}
|
|
4113
|
+
* Contract:
|
|
4114
|
+
* https://pricing.augur-api.com/openapi.json#/paths/~1web-pricing~1{webPricingUid}/get
|
|
4115
|
+
*
|
|
4116
|
+
* @param webPricingUid Web pricing rule unique ID
|
|
4117
|
+
* @param params WebPricingGetParams (query string)
|
|
4118
|
+
* @returns BaseResponse whose `data` is WebPricingGetData
|
|
4119
|
+
*/
|
|
4120
|
+
get: (webPricingUid: number, params?: WebPricingGetParams) => Promise<BaseResponse<WebPricingGetData>>;
|
|
4121
|
+
/**
|
|
4122
|
+
* Update Web Pricing Rule
|
|
4123
|
+
* Call: api.pricing.webPricing.update(webPricingUid, data)
|
|
4124
|
+
*
|
|
4125
|
+
* Request body: Change a web pricing rule; only the fields sent are changed
|
|
4126
|
+
*
|
|
4127
|
+
* Errors:
|
|
4128
|
+
* 400: The body is missing or not a JSON object. Or The body failed validation; the message
|
|
4129
|
+
* names the field.
|
|
4130
|
+
* 404: No record with this ID.
|
|
4131
|
+
*
|
|
4132
|
+
* PUT https://pricing.augur-api.com/web-pricing/{webPricingUid}
|
|
4133
|
+
* Contract:
|
|
4134
|
+
* https://pricing.augur-api.com/openapi.json#/paths/~1web-pricing~1{webPricingUid}/put
|
|
4135
|
+
*
|
|
4136
|
+
* @param webPricingUid Web pricing rule unique ID
|
|
4137
|
+
* @param data WebPricingUpdateBody (request body)
|
|
4138
|
+
* @returns BaseResponse whose `data` is WebPricingUpdateData
|
|
4139
|
+
*/
|
|
4140
|
+
update: (webPricingUid: number, data: WebPricingUpdateBody) => Promise<BaseResponse<WebPricingUpdateData>>;
|
|
4141
|
+
/**
|
|
4142
|
+
* Soft Delete Web Pricing Rule
|
|
4143
|
+
* Call: api.pricing.webPricing.delete(webPricingUid)
|
|
4144
|
+
*
|
|
4145
|
+
* Errors:
|
|
4146
|
+
* 404: No record with this ID.
|
|
4147
|
+
*
|
|
4148
|
+
* DELETE https://pricing.augur-api.com/web-pricing/{webPricingUid}
|
|
4149
|
+
* Contract:
|
|
4150
|
+
* https://pricing.augur-api.com/openapi.json#/paths/~1web-pricing~1{webPricingUid}/delete
|
|
4151
|
+
*
|
|
4152
|
+
* @param webPricingUid Web pricing rule unique ID
|
|
4153
|
+
* @returns BaseResponse whose `data` is WebPricingDeleteData
|
|
4154
|
+
*/
|
|
4155
|
+
delete: (webPricingUid: number) => Promise<BaseResponse<WebPricingDeleteData>>;
|
|
4156
|
+
customers: {
|
|
4157
|
+
/**
|
|
4158
|
+
* List Web Pricing Customers
|
|
4159
|
+
* Call: api.pricing.webPricing.customers.list(webPricingUid, params)
|
|
4160
|
+
*
|
|
4161
|
+
* Errors:
|
|
4162
|
+
* 400: Invalid orderBy: MUST be one field|ASC or field|DESC, the field a
|
|
4163
|
+
* web_pricing_x_customer column.
|
|
4164
|
+
* 404: No record with this ID.
|
|
4165
|
+
*
|
|
4166
|
+
* GET https://pricing.augur-api.com/web-pricing/{webPricingUid}/customers
|
|
4167
|
+
* Contract:
|
|
4168
|
+
* https://pricing.augur-api.com/openapi.json#/paths/~1web-pricing~1{webPricingUid}~1customers/get
|
|
4169
|
+
*
|
|
4170
|
+
* @param webPricingUid Web pricing rule whose customer assignments are addressed
|
|
4171
|
+
* @param params WebPricingCustomersListParams (query string)
|
|
4172
|
+
* @returns BaseResponse whose `data` is WebPricingCustomersListData
|
|
4173
|
+
*/
|
|
4174
|
+
list: (webPricingUid: number, params?: WebPricingCustomersListParams) => Promise<BaseResponse<WebPricingCustomersListData>>;
|
|
4175
|
+
/**
|
|
4176
|
+
* Assign Web Pricing Customer
|
|
4177
|
+
* Call: api.pricing.webPricing.customers.create(webPricingUid, data)
|
|
4178
|
+
*
|
|
4179
|
+
* Request body: Assign a customer to a web pricing rule whose customerMode is ONLY or EXCEPT
|
|
4180
|
+
*
|
|
4181
|
+
* Success status: 201 (not 200)
|
|
4182
|
+
*
|
|
4183
|
+
* Errors:
|
|
4184
|
+
* 400: The body is missing or not a JSON object. Or customerId is required and MUST be a
|
|
4185
|
+
* positive integer. Or customer assignments apply only when the rule's customerMode is
|
|
4186
|
+
* ONLY or EXCEPT.
|
|
4187
|
+
* 404: No record with this ID.
|
|
4188
|
+
* 409: customerId is already assigned to this web pricing rule.
|
|
4189
|
+
*
|
|
4190
|
+
* POST https://pricing.augur-api.com/web-pricing/{webPricingUid}/customers
|
|
4191
|
+
* Contract:
|
|
4192
|
+
* https://pricing.augur-api.com/openapi.json#/paths/~1web-pricing~1{webPricingUid}~1customers/post
|
|
4193
|
+
*
|
|
4194
|
+
* @param webPricingUid Web pricing rule whose customer assignments are addressed
|
|
4195
|
+
* @param data WebPricingCustomersCreateBody (request body)
|
|
4196
|
+
* @returns BaseResponse whose `data` is WebPricingCustomersCreateData
|
|
4197
|
+
*/
|
|
4198
|
+
create: (webPricingUid: number, data: WebPricingCustomersCreateBody) => Promise<BaseResponse<WebPricingCustomersCreateData>>;
|
|
4199
|
+
/**
|
|
4200
|
+
* Get Web Pricing Customer
|
|
4201
|
+
* Call: api.pricing.webPricing.customers.get(webPricingUid, customerId)
|
|
4202
|
+
*
|
|
4203
|
+
* Errors:
|
|
4204
|
+
* 404: No record with this ID.
|
|
4205
|
+
*
|
|
4206
|
+
* GET https://pricing.augur-api.com/web-pricing/{webPricingUid}/customers/{customerId}
|
|
4207
|
+
* Contract:
|
|
4208
|
+
* https://pricing.augur-api.com/openapi.json#/paths/~1web-pricing~1{webPricingUid}~1customers~1{customerId}/get
|
|
4209
|
+
*
|
|
4210
|
+
* @param webPricingUid Web pricing rule whose customer assignments are addressed
|
|
4211
|
+
* @param customerId P21 customer ID
|
|
4212
|
+
* @param params WebPricingCustomersGetParams (query string)
|
|
4213
|
+
* @returns BaseResponse whose `data` is WebPricingCustomersGetData
|
|
4214
|
+
*/
|
|
4215
|
+
get: (webPricingUid: number, customerId: number, params?: WebPricingCustomersGetParams) => Promise<BaseResponse<WebPricingCustomersGetData>>;
|
|
4216
|
+
/**
|
|
4217
|
+
* Update Web Pricing Customer
|
|
4218
|
+
* Call: api.pricing.webPricing.customers.update(webPricingUid, customerId, data)
|
|
4219
|
+
*
|
|
4220
|
+
* Request body: Change a customer assignment on a web pricing rule; the rule and customer
|
|
4221
|
+
* come from the path
|
|
4222
|
+
*
|
|
4223
|
+
* Errors:
|
|
4224
|
+
* 400: The body is missing or not a JSON object. Or The body failed validation; the message
|
|
4225
|
+
* names the field.
|
|
4226
|
+
* 404: No record with this ID.
|
|
4227
|
+
*
|
|
4228
|
+
* PUT https://pricing.augur-api.com/web-pricing/{webPricingUid}/customers/{customerId}
|
|
4229
|
+
* Contract:
|
|
4230
|
+
* https://pricing.augur-api.com/openapi.json#/paths/~1web-pricing~1{webPricingUid}~1customers~1{customerId}/put
|
|
4231
|
+
*
|
|
4232
|
+
* @param webPricingUid Web pricing rule whose customer assignments are addressed
|
|
4233
|
+
* @param customerId P21 customer ID
|
|
4234
|
+
* @param data WebPricingCustomersUpdateBody (request body)
|
|
4235
|
+
* @returns BaseResponse whose `data` is WebPricingCustomersUpdateData
|
|
4236
|
+
*/
|
|
4237
|
+
update: (webPricingUid: number, customerId: number, data: WebPricingCustomersUpdateBody) => Promise<BaseResponse<WebPricingCustomersUpdateData>>;
|
|
4238
|
+
/**
|
|
4239
|
+
* Remove Web Pricing Customer
|
|
4240
|
+
* Call: api.pricing.webPricing.customers.delete(webPricingUid, customerId)
|
|
4241
|
+
*
|
|
4242
|
+
* Errors:
|
|
4243
|
+
* 404: No record with this ID.
|
|
4244
|
+
*
|
|
4245
|
+
* DELETE https://pricing.augur-api.com/web-pricing/{webPricingUid}/customers/{customerId}
|
|
4246
|
+
* Contract:
|
|
4247
|
+
* https://pricing.augur-api.com/openapi.json#/paths/~1web-pricing~1{webPricingUid}~1customers~1{customerId}/delete
|
|
4248
|
+
*
|
|
4249
|
+
* @param webPricingUid Web pricing rule whose customer assignments are addressed
|
|
4250
|
+
* @param customerId P21 customer ID
|
|
4251
|
+
* @returns BaseResponse whose `data` is WebPricingCustomersDeleteData
|
|
4252
|
+
*/
|
|
4253
|
+
delete: (webPricingUid: number, customerId: number) => Promise<BaseResponse<WebPricingCustomersDeleteData>>;
|
|
4254
|
+
};
|
|
4255
|
+
};
|
|
4256
|
+
}
|
|
4257
|
+
//# sourceMappingURL=types.d.ts.map
|